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

Class ESIStandardProcedureLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.ESIStandardProcedureLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIStandardProcedureLinkRenderer
extends BasicESIRenderer

This class renders the output of MPMStandardProcedureLink (i.e. <StandardProcedureLink> </StandardProcedureLink>) in ESI response.


Supported API: true

Extendable: true

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, MPMStandardProcedureLink mpmStandardProcedureLink, Collection<ESITarget> 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 Standard Procedure Links.
protected Persistable	getContextToFetchOptionSetInfo()	Returns the context object to be used for fetching the option set information.
protected MPMOperationHolder	getRoot()	Gets the value of the attribute: root.
MPMProcessPlan	getRootProcessPlan()	Returns the top level process plan.
protected Persistable	getRootToFetchOptionSetInfo()	Returns the root object to be used for fetching option set information.
protected Collection<ESITargetAssociation>	getTargetAssociations()	Gets the value of the attribute: targetAssociations; A collection ESITargetAssociation objects.
protected Collection	getTargets()	Deprecated. (Since 10.2) Use getTargetAssociations() Supported API: true
protected Collection<MPMStandardProcedureLink>[]	getUsageLinks()	Gets the value of the attribute: usageLinks.
protected String	getWcAdapter()	Deprecated. Use BasicESIRenderer.getAdapterName() instead. Supported API: true
void	setData(MPMOperationHolder root, MPMOperationHolder prevExportedRoot, Collection<MPMStandardProcedureLink>[] standardProcedureLinks, Collection<ESITargetAssociation> tgtAssocs, String auth, String wcAdapter, ViewReference defaultView)	Initializes this renderer instance appropriately.
void	setOperationLabelToOperationInfoMap(TreeMap<String,OperationInfo> opLabelToOperationInfoMap)	Sets the operation label to operation object information map.
void	setRootProcessPlan(MPMProcessPlan processPlan)	Sets the top level process plan.
protected void	validate()	Throws an exception if the attribute root, targets or the Collection usageLinks 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

getTargets

protected Collection getTargets()

Deprecated.

(Since 10.2) Use getTargetAssociations()

Supported API: true

Gets the value of the attribute: targetAssociations; A collection ESITargetAssociation objects.

Returns:

Collection

getTargetAssociations

protected Collection<ESITargetAssociation> getTargetAssociations()

Gets the value of the attribute: targetAssociations; A collection ESITargetAssociation objects.

Supported API: true

Returns:

Collection

getUsageLinks

protected Collection<MPMStandardProcedureLink>[] getUsageLinks()

Gets the value of the attribute: usageLinks.

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

Populates the associated VdbBuilder instance with the response data for Standard Procedure Links. It creates a collection of all the added, changed and unchanged standard procedures which is further processed by the ESIProcessPlanRenderer.

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

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

setData

public void setData(MPMOperationHolder root,
 MPMOperationHolder prevExportedRoot,
 Collection<MPMStandardProcedureLink>[] standardProcedureLinks,
 Collection<ESITargetAssociation> tgtAssocs,
 String auth,
 String wcAdapter,
 ViewReference defaultView)
             throws ESIRendererException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

root - Process plan for which to render standard procedure links.

prevExportedRoot - Previously exported operation holder (process plan/operation/sequence). Can be null.

standardProcedureLinks - Array of collections of added, deleted, changed and unchanged standard procedure links.

tgtAssocs - 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 process plan resides in.

Throws:

ESIRendererException - if any of the invoked methods threw this exception.

adjustElement

public com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 MPMStandardProcedureLink mpmStandardProcedureLink,
 Collection<ESITarget> targets)

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 - element

group - output group

mpmStandardProcedureLink - instance of MPMStandardProcedureLink.

targets - Collection of ESITarget objects.

Returns:

Element

validate

protected void validate()
                 throws ESIRendererException

Throws an exception if the attribute root, targets or the Collection usageLinks 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.

setRootProcessPlan

public void setRootProcessPlan(MPMProcessPlan processPlan)

Sets the top level process plan.

Supported API: true

Parameters:

processPlan - - process plan which is the root of the process plan structure.

getRootProcessPlan

public MPMProcessPlan getRootProcessPlan()

Returns the top level process plan.

Supported API: true

Returns:

process plan which is the root of the process plan structure.

getRootToFetchOptionSetInfo

protected Persistable getRootToFetchOptionSetInfo()

Returns the root object to be used for fetching option set information. This method is intended to be overridden by a customizer if they want to use a different root than the default one. By default, it returns the process plan obtained from the API getRootProcessPlan() if it is not null, and that returned from getRoot() otherwise. The renderer "com.ptc.windchill.esi.ov.ChoiceMappableChoiceLinkRenderer" uses this object to find the appropriate option set for the current standard procedure link being rendered. Check the java doc of this renderer for more information.

Supported API: true

Returns:

the root object to be used for fetching option set information.

getContextToFetchOptionSetInfo

protected Persistable getContextToFetchOptionSetInfo()

Returns the context 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 context than the default one. By default, it returns the process plan obtained from the API getRootProcessPlan() if it is not null, and that returned from getRoot() otherwise. The renderer "com.ptc.windchill.esi.ov.ChoiceMappableChoiceLinkRenderer" uses this object to render appropriate context information in the response. Check the java doc of this renderer for more information.

Supported API: true

Returns:

the context object to be used for fetching the option set information.

setOperationLabelToOperationInfoMap

public void setOperationLabelToOperationInfoMap(TreeMap<String,OperationInfo> opLabelToOperationInfoMap)

Sets the operation label to operation object information map. Which can be used to render the branching and returning operation for the standard procedure

Supported API: true

Parameters:

opLabelToOperationInfoMap - operation label to operation object information map.