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

Class ESIOperatedOnPartLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

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

All Implemented Interfaces:

ESIRenderer

public class ESIOperatedOnPartLinkRenderer
extends BasicESIRenderer

This class renders the output of MPMOperationToOperatedPartLink (i.e. <OprOperatedOnPart> </OprOperatedOnPart>) 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
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, MPMOperationToOperatedPartLink operationToOperatedPartLink, WTPartMaster partMaster, Collection<ESITarget> targets)	Allows subclasses to fix the contents of an Element before it is added to the output group(s).
void	buildGroups()	Calls buildAGroup(String, Collection<MPMOperationToOperatedPartLink>) method for respective bucket.
Collection<WTPart>	getOperatedOnPartIterations()	Returns the collection of parts associated with the Operated on part link.
protected Collection<MPMOperationToOperatedPartLink>[]	getOperatedOnPartLinks()	Gets the value of the attribute: opreratedOnPartLinks.
Collection<WTPartMaster>	getOperatedOnParts()	Returns the operated on part of the operations Supported API: true
protected MPMOperation	getRoot()	Gets the value of the attribute: root.
protected Collection<ESITargetAssociation>	getTargetAssociations()	Gets the value of the attribute: targetAssocs.
protected String	getWcAdapter()	Deprecated. Use BasicESIRenderer.getAdapterName() instead. Supported API: true
void	setData(MPMOperation root, Collection<MPMOperationToOperatedPartLink>[] operatedOnPartLinks, Collection<ESITargetAssociation> targetAssocs, String auth, String wcAdapter)	Initializes this renderer instance appropriately.
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

getOperatedOnPartLinks

protected Collection<MPMOperationToOperatedPartLink>[] getOperatedOnPartLinks()

Gets the value of the attribute: opreratedOnPartLinks.

Supported API: true

Returns:

Collection[]

getRoot

protected MPMOperation getRoot()

Gets the value of the attribute: root.

Supported API: true

Returns:

MPMOperation

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.

getOperatedOnParts

public Collection<WTPartMaster> getOperatedOnParts()
                                            throws WTException

Returns the operated on part of the operations

Supported API: true

Returns:

Collection the collection of part master

Throws:

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

getOperatedOnPartIterations

public Collection<WTPart> getOperatedOnPartIterations()
                                               throws WTException

Returns the collection of parts associated with the Operated on part link.

Supported API: true

Returns:

Collection the collection of parts

Throws:

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

buildGroups

public void buildGroups()
                 throws ESIRendererException

Calls buildAGroup(String, Collection<MPMOperationToOperatedPartLink>) method for respective bucket.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

setData

public void setData(MPMOperation root,
 Collection<MPMOperationToOperatedPartLink>[] operatedOnPartLinks,
 Collection<ESITargetAssociation> targetAssocs,
 String auth,
 String wcAdapter)
             throws WTException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

root - Object (operation) for which to process operated on part links.

operatedOnPartLinks - Array of collections of added, deleted, changed and unchanged operated on part links.

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.

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.

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 MPMOperationToOperatedPartLink operationToOperatedPartLink,
 WTPartMaster partMaster,
 Collection<ESITarget> targets)
                                                       throws ESIRendererException

Allows subclasses to fix the contents of an Element before it is added to the output group(s). Default behavior is to return the input Element itself.

Supported API: true

Parameters:

elem - - I*E Element to be updated.

group - - Logical name of the group to which the Element will be added.

operationToOperatedPartLink - - The operation to operated part link being processed.

partMaster - - Part master associated with the input operation to operated part link.

targets - - Collection of ESITarget objects.

Returns:

The updated Element.

Throws:

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