Package com.ptc.windchill.esi.mpml.processplan.sequence

Class ESISequenceRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.sequence.ESISequenceRenderer

All Implemented Interfaces:

ESIRenderer

public class ESISequenceRenderer
extends BasicESIRenderer

This class renders MPMSequence object.

Supported API: true

Extendable: true

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ESISequenceRenderer.PreviousExportedIterationKey	The following is an inner class intended to be used only by this outer class (or subclasses thereof).

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()	Renders Sequence object and populates the VDB instance with Sequence and its associated objects information.
protected Map<ESISequenceRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>>	getPreviousExportedIterationAssociations(Collection<ESITargetAssociation> currentTargetAssns, boolean delta)	Populates a map that associates each previous exported iteration with a collection of Target associations.
protected MPMSequenceHolder	getRoot()	Gets the value of the attribute: root.
protected Persistable	getRootToFetchOpionSetInfo()	Returns the root object to be used for fetching the option set information.
protected Collection<MPMSequence>	getSequences()	Gets the value of the attribute: sequences.
protected Collection<ESITargetAssociation>	getTargetAssociations()	Gets the value of the attribute: targetAssocs.
protected int	getTransactionId()	Gets the value of the attribute: transactionId.
protected String	getWcAdapter()	Deprecated. Use BasicESIRenderer.getAdapterName() instead. Supported API: true
protected boolean	hasNestedSequences(MPMSequence sequence)	Returns whether sequence has nested sequence or not.
void	setData(MPMSequenceHolder root, Collection<MPMSequence> sequences, boolean delta, boolean resources, boolean standardProcedures, int suboperationDepth, boolean operatedOnPart, boolean documents, boolean workInstructions, String configSpec, Collection<ESITargetAssociation> targetAssocs, String auth, String wcAdapter, int transactionID, ViewReference defaultView)	Establish the renderer's state so that it can process requests.
protected void	validate()	Force all subclasses to implement the method.

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

getTargetAssociations

protected Collection<ESITargetAssociation> getTargetAssociations()

Gets the value of the attribute: targetAssocs.

Supported API: true

Returns:

Collection

getSequences

protected Collection<MPMSequence> getSequences()

Gets the value of the attribute: sequences.

Supported API: true

Returns:

Collection

getRoot

protected MPMSequenceHolder getRoot()

Gets the value of the attribute: root.

Supported API: true

Returns:

MPMSequenceHolder

getWcAdapter

@Deprecated
protected String getWcAdapter()

Deprecated.

Use BasicESIRenderer.getAdapterName() instead.

Supported API: true

Returns the value of the attribute adapterName. This attribute holds the name of the Windchill Adapter instance where the Query-Objects webject is to be executed.

Returns:

The value stored in the field adapterName.

getTransactionId

protected int getTransactionId()

Gets the value of the attribute: transactionId.

Supported API: true

Returns:

int

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders Sequence object and populates the VDB instance with Sequence and its associated objects information. Delegates the work of rendering associated objects by invoking respective renderers.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

setData

public void setData(MPMSequenceHolder root,
 Collection<MPMSequence> sequences,
 boolean delta,
 boolean resources,
 boolean standardProcedures,
 int suboperationDepth,
 boolean operatedOnPart,
 boolean documents,
 boolean workInstructions,
 String configSpec,
 Collection<ESITargetAssociation> targetAssocs,
 String auth,
 String wcAdapter,
 int transactionID,
 ViewReference defaultView)
             throws WTException

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

Supported API: true

Parameters:

root - - Root object (process plan) for which to render the sequences.

sequences - - Collection of sequences being rendered.

delta - - If "true", returns only the changes since the last successful export. Default is "true".

resources - - If true, returns the resources.

standardProcedures - - Indicates whether the associated Standard Procedures need to be rendered.

suboperationDepth - - The number of levels in an operation to process; default is 1.

operatedOnPart - - If true, returns the operated on parts associated to an operation.

documents - - If true, returns the documents associated with the sequences.

workInstructions - - If true, returns work instructions.

configSpec - - Configuration specification to use when navigating a BOM.

targetAssocs - - Collection of ESITargetAssociation objects.

auth - - I*E authentication information to use when executing a query task.

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

transactionID - - ID of the underlying ESI transaction.

defaultView - - View reference of the parent process plan.

Throws:

WTException - if any of the invoked methods throws this exception.

validate

protected void validate()
                 throws ESIRendererException

Force all subclasses to implement the method. The concrete method is expected to examine the attributes of the object and throw an exception if they are not set properly.

Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

getPreviousExportedIterationAssociations

protected Map<ESISequenceRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>> getPreviousExportedIterationAssociations(Collection<ESITargetAssociation> currentTargetAssns,
 boolean delta)
                                                                                                                                   throws WTException

Populates a map that associates each previous exported iteration with a collection of Target associations. Getting the previous exported iteration applies only when differences are desired, i.e. delta is true, and the object is associated with at least one target. When delta is false, or the object is associated with zero targets, the object is treated as though there aren't any previous exported iterations. Invokes the API ESITransactionUtility.latestObjectExport(Collection, ESIPropertyRequest)

Supported API: true

Parameters:

currentTargetAssns - - Collection of ESITargetAssociation objects.

delta - - If false, previous exported iteration would be null for each target association.

Returns:

Map of PreviousExportedIterationKey and the collection of ESITargetAssociation

Throws:

WTException - if any of the invoked methods throws this exception.

getRootToFetchOpionSetInfo

protected Persistable getRootToFetchOpionSetInfo()

Returns the root object to be used for fetching the option set information. This method is intended to be overridden by a customizer if they want to use a different root other than the default one. It returns the process plan obtained by invoking getRoot() by default. The renderer "com.ptc.windchill.esi.ov.ChoiceMappableChoiceLinkRenderer" uses this object to find the appropriate option set for the current sequence being rendered. Check the java doc of this renderer for more information.

Supported API: true

Returns:

the root object.

hasNestedSequences

protected boolean hasNestedSequences(MPMSequence sequence)
                              throws ESIRendererException

Returns whether sequence has nested sequence or not. Value 'true' is returned when specified sequence has nested sequence otherwise 'false'.

Supported API: true

Parameters:

sequence - - The sequence that needs to be checked for having nested sequences

Returns:

- 'true' when specified sequence has nested sequence otherwise 'false'

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.