Package com.ptc.windchill.esi.effectivity

Class ESIEffectivityRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.effectivity.ESIEffectivityRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIEffectivityRenderer
extends BasicESIRenderer

This class has methods to render effectivity associated to a RevisionControlled object and build the relevant portions of the ESI response.

Supported API: true

Extendable: false

Field Summary

Fields inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

adapterName, authentication, currentTarget, DELIMITER, objectTypeDefs, OPTIONSVARIANTS_HELPER_CLASS_STRING, SEPARATOR, taskHelper, XML_META_NAME

Method Summary

Modifier and Type	Method	Description
protected void	buildGroups()	Output generator for the class.
void	getEff(Persistable root, Persistable prevIteration, String auth, String wcAdapter, VdbBuilder builder, List<Eff>[] effList, String releaseClass, Collection<ESITarget> targets)	Invokes setData() and render() respectiviely to set the required data and render effectivity but does not call asVDB() since the caller of this method is responsible for doing that.
void	setData(Persistable root, Persistable prevIteration, List<Eff>[] effList, String auth, String wcAdapter, String releaseClass, Collection<ESITarget> targets)	Establish the renderer's state with required data so that it can process requests.
protected void	validate()	Make sure the object is ready to process.

Methods inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

addAtt, adjustConfigurableAndCollapsibleAtts, adjustDateEffCxt, adjustDateEffectivities, adjustEffectivities, adjustLotNumberEffCxt, adjustLotNumberEffectivities, adjustObjectID, adjustSerialNumberEffCxt, adjustSerialNumberEffectivities, adjustTargets, buildUfidString, evaluateBussinessRule, fetchLatestEffectivities, formatDateEffectivityElement, getAdapterName, getAssignedVariantSpec, getAssignedVariantSpec, getAUMRenderer, getAuth, getBuilder, getEffectivityElementMap, getEffectivityHandler, getEffectivityTargetAttributes, getElements, getERPMaterialAttributeList, getERPMaterialAttributeList, getERPMaterialTargetAttributes, getFormatedDate, getGroupInfo, getGroupInfo, getGroupInfo, getMap, getMap, getMapInfo, getMapInfo, getMapInfo, getNavigationFilter, getObjectTypeDefs, getPlantSpecificAttributeList, getPlantSpecificAttributeList, getPlantSpecificTargetAttributes, getPreviousObject, getPreviousPublishedEffectivity, getTargetsFromAssns, getTargetUtility, getTransactionUtility, getUnwantedAttributes, getVersionRefObjectRefMap, getWCAttributeList, getWCAttributeList, initEffectivityHandler, initializeElementForGroup, invokeQueryTask, invokeQueryTask, invokeQueryTask, invokeQueryTaskForObjects, isExpressionToBePublished, isGroupAvailable, isPublishAssocOptionSetFlagEnabled, mapDateEffectivities, mapEffectivities, mapEffectivityAttributes, mapEffectivityElement, mapEffectivityParentElement, mapElement, mapElement, mapElement, mapElementWithEffectivityAttrs, mapLotNumberEffectivities, mapObject, mapObject, mapSerialNumberEffectivities, mergeElements, overrideAttrValue, populateDateEffectivityInfo, populateEffectivityInfo, processBussinessRulesWithAnd, processBussinessRuleValidationResultSet, processNoMatchingVersionFound, removeAttributesNotRequired, removeUnwantedEffectivityAttributes, render, renderAssociatedSkinnyVariantSpec, renderAssociatedVariantSpec, renderAssocOptionSetLinks, renderAssocSkinnyVariantSpec, renderAssocVariantSpec, renderATONavigationFilter, renderChoiceRules, renderEffectivities, renderEffectivities, renderExpressions, renderOptionSets, renderRoleBObjectOfModuleVariantLink, setAttrValue, setAttrValue, setAttrValues, setBuilder, setCurrentTarget, setCurrentTarget, setCurrentTargetFromTgtAssocs, setEffectivityHandler, setObjectTypeDefs, setObjectTypeDefs, setObjectTypeDefsFromObj, setStartEndEffAttr, setTransactionUtility, shallPublishAssocOptionSet, shouldRenderEffectivityElementInPartElement, shouldUseOldEffectivityBehaviour, storeCurrentAndItsPreviousObject, storeCurrentAndItsPreviousObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getEff

public void getEff(Persistable root,
 Persistable prevIteration,
 String auth,
 String wcAdapter,
 VdbBuilder builder,
 List<Eff>[] effList,
 String releaseClass,
 Collection<ESITarget> targets)
            throws WTException

Invokes setData() and render() respectiviely to set the required data and render effectivity but does not call asVDB() since the caller of this method is responsible for doing that.

Supported API: true

Parameters:

root - - Instance of current persistable which is being currently processed for rendering associated effectivities.

prevIteration - - Previous published iteration of persistable object

auth - - This parameter contains authentication information from I*E.

wcAdapter - - This parameter contains the name of the Windchill adapter.

effList - - Collection of effectivity objects to be rendered.

releaseClass - - Release class of the ESI object.

targets - - Collection of ESITarget objects.

Throws:

WTException

setData

public void setData(Persistable root,
 Persistable prevIteration,
 List<Eff>[] effList,
 String auth,
 String wcAdapter,
 String releaseClass,
 Collection<ESITarget> targets)
             throws WTException

Establish the renderer's state with required data so that it can process requests.

Supported API: true

Parameters:

root - - Instance of current persistable which is being currently processed for rendering associated effectivities.

prevIteration - - Previous published iteration of persistable object

effList - - Collection of effectivity objects to be rendered.

auth - - Info*Engine authentication information to use when executing a query task.

wcAdapter - - Windchill adapter instance name to use when executing a webject.

releaseClass - - Release class of ESI object.

targets - - Collection of ESITarget objects.

parentlEement -

Throws:

WTException

buildGroups

protected void buildGroups()
                    throws ESIRendererException,
Exception

Output generator for the class. It obtains effectivity element. Renders date, serial and lot effectivities and populate effectivity element with rendered information.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

Exception

validate

protected void validate()
                 throws ESIRendererException

Make sure the object is ready to process. If root, auth, or wcAdapter are null, throws an exception.

Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException