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

Class ESIOperationUsageLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.operation.ESIOperationUsageLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIOperationUsageLinkRenderer
extends BasicESIRenderer

This class renders the output of MPMOperation and MPMOperationUsageLink (i.e. <Operation> </Operation>) in ESI response.


Supported API: true

Extendable: true

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ESIOperationUsageLinkRenderer.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
com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, MPMOperation mpmOperation, Collection targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups()	Populates the associated VdbBuilder instance with the response data for Operation(s) It creates a collection of all the added, changed and unchanged operations which is further processed by the ESIProcessPlanRenderer and ESIOperationRenderer. Calls adjustObjectID(). Calls adjustTargets(). Calls adjustElement().
TreeMap<String,OperationInfo>	getOperationLabelToOperationInfoMap()	Returns the sorted map containing operation label as key and operation object reference as a value.
protected Collection<MPMOperationUsageLink>[]	getOperationLinks()	Gets the value of the attribute: operationLinks.
protected Map<ESIOperationUsageLinkRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>>	getPreviousExportedIterationAssociations(MPMOperation mpmOperation, Collection<ESITargetAssociation> tgtAssociations)	Computes the previous exported iteration for the input target associations.
protected Map<ESIOperationUsageLinkRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>>	getPreviousExportedIterationAssociations(MPMOperation mpmOperation, Collection<ESITargetAssociation> tgtAssociations, boolean delta)	Computes the previous exported iteration for the input target associations.
protected MPMOperationHolder	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<ESITargetAssociation>	getTargetAssociations()	Gets the value of the attribute: targetAssocs.
protected String	getWcAdapter()	Deprecated. Use BasicESIRenderer.getAdapterName() instead. Supported API: true
void	setData(MPMProcessPlan processplan)	Sets the instance variable processPlan to the input object.
void	setData(MPMOperationHolder root, Collection<MPMOperationUsageLink>[] operationLinks, HashMap oldAttrs, Collection<ESITargetAssociation> targetAssocs, String auth, String wcAdapter, ViewReference defaultView, Collection<MPMOperationToPartLink> oprToPartsLinks)	Initializes this renderer instance appropriately.
protected void	validate()	Throws an exception if the attribute root, targetAssocs or the Collection operationLinks is null or contains null objects.

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

getOperationLinks

protected Collection<MPMOperationUsageLink>[] getOperationLinks()

Gets the value of the attribute: operationLinks.

Supported API: true

Returns:

Collection[]

getRoot

protected MPMOperationHolder getRoot()

Gets the value of the attribute: root.

Supported API: true

Returns:

MPMOperationHolder

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.

buildGroups

protected void buildGroups()
                    throws ESIRendererException,
WTException

Populates the associated VdbBuilder instance with the response data for Operation(s) It creates a collection of all the added, changed and unchanged operations which is further processed by the ESIProcessPlanRenderer and ESIOperationRenderer.

• Calls adjustObjectID().
• Calls adjustTargets().
• Calls adjustElement().

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - , if the preference "Show No Qualifying Version Found Error" is set to "Yes" and when no qualifying version was found for the operation master.

WTException

setData

public void setData(MPMOperationHolder root,
 Collection<MPMOperationUsageLink>[] operationLinks,
 HashMap oldAttrs,
 Collection<ESITargetAssociation> targetAssocs,
 String auth,
 String wcAdapter,
 ViewReference defaultView,
 Collection<MPMOperationToPartLink> oprToPartsLinks)
             throws WTException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

root - Object (process plan, sequence or operation) for which to process operation usage links.

operationLinks - Array of collections of added, deleted, changed and unchanged operation usage links.

oldAttrs - HashMap of names and values of attributes on a previously published operation usage link.

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.

defaultView - ViewReference object representing the Windchill view that the top level process plan resides in.

oprPartsLinks - - Collection of OprBomAllocatedPart objects.

Throws:

WTException - thrown WTException, if any during data set.

setData

public void setData(MPMProcessPlan processplan)
             throws WTException

Sets the instance variable processPlan to the input object.

Supported API: true

Parameters:

processplan - - MPMProcessPlan object to set processPlan to.

Throws:

WTException - thrown wt exception if any during data set.

adjustElement

public com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 MPMOperation mpmOperation,
 Collection targets)
                                                    throws ESIRendererException

Allow subclasses to fix the contents of an element before it's added to the output group(s). Default behavior is to return the argument.

Supported API: true

Parameters:

elem - Input Element.

group - Input the group.

mpmOperation - input the mpm operation

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

validate

protected void validate()
                 throws ESIRendererException

Throws an exception if the attribute root, targetAssocs or the Collection operationLinks is null or contains null objects.

Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException - , if any of the said instance members are null, or are invalid.

getPreviousExportedIterationAssociations

protected Map<ESIOperationUsageLinkRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>> getPreviousExportedIterationAssociations(MPMOperation mpmOperation,
 Collection<ESITargetAssociation> tgtAssociations,
 boolean delta)
                                                                                                                                             throws WTException

Computes the previous exported iteration for the input target associations. Invokes the API ESITransactionUtility.latestObjectExport(Collection, ESIPropertyRequest)

Computing a previous exported iteration is target sensitive because each target is not guaranteed to have the same previously exported iteration. For example, an operation could be associated with target 1, then exported, then associated with target 2, and exported a second time. In the case of the second export, target 1 has a previous exported iteration, while target 2 does not. Therefore, the output map contains a previous exported iteration mapped to collection of targets.

Supported API: true

Parameters:

mpmOperation - - Current operation being rendered.

tgtAssociations - - Collection of distribution target associations. Typically the target association between the input operation and current distribution target being processed.

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

Returns:

a map whose key is a previous Exported Iteration and the value is a collection of distribution target associations.

Throws:

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

getPreviousExportedIterationAssociations

protected Map<ESIOperationUsageLinkRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>> getPreviousExportedIterationAssociations(MPMOperation mpmOperation,
 Collection<ESITargetAssociation> tgtAssociations)
                                                                                                                                             throws WTException

Computes the previous exported iteration for the input target associations. Invokes the API ESITransactionUtility.latestObjectExport(Collection, ESIPropertyRequest)

Computing a previous exported iteration is target sensitive because each target is not guaranteed to have the same previously exported iteration. For example, an operation could be associated with target 1, then exported, then associated with target 2, and exported a second time. In the case of the second export, target 1 has a previous exported iteration, while target 2 does not. Therefore, the output map contains a previous exported iteration mapped to collection of targets.

Supported API: true

Parameters:

mpmOperation - - Current operation being rendered.

tgtAssociations - - Collection of distribution target associations. Typically the target association between the input operation and current distribution target being processed.

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

Returns:

a map whose key is a previous Exported Iteration and the value is a collection of distribution target associations.

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 which is the root of the process plan structure by default. The renderer "com.ptc.windchill.esi.ov.ChoiceMappableChoiceLinkRenderer" uses this object to find the appropriate option set for the current operation usage link being rendered. Check the java doc of this renderer for more information.

Supported API: true

Returns:

the root object

getOperationLabelToOperationInfoMap

public TreeMap<String,OperationInfo> getOperationLabelToOperationInfoMap()

Returns the sorted map containing operation label as key and operation object reference as a value.

Supported API: true

Returns:

the sorted map containing operation label as key and operation object reference as a value.