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

Class ESIWorkInstructionRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.ESIWorkInstructionRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIWorkInstructionRenderer
extends BasicESIRenderer

This class renders the work instructions.

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, MPMOperationHolder currHolder, Collection targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups()	Builds the output group for the work instruction for each MPMOperation and BOM associated with Process Plan.
protected MPMOperationHolder	getHolder()	Gets the value of the attribute: root.
protected MPMOperationHolder	getPrevRev()	Gets the value of the attribute: wcAdapter.
protected Collection<ESITargetAssociation>	getTargetAssociations()	Gets the value of the attribute: targetAssociations; A collection ESITargetAssociation objects.
protected Collection<ESITargetAssociation>	getTargets()	Deprecated. (Since 10.2) Use getTargetAssociations()
void	setData(MPMOperationHolder holder, MPMOperationHolder prevRev, Collection<ESITargetAssociation> tgtAssociations, ViewReference defaultView)	Deprecated. Use setData(MPMOperationHolder, MPMOperationHolder, Collection, ViewReference, Collection) instead.
void	setData(MPMOperationHolder holder, MPMOperationHolder prevRev, Collection<ESITargetAssociation> tgtAssociations, ViewReference defaultView, Collection<WTPart> partSet)	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

getTargets

protected Collection<ESITargetAssociation> getTargets()

Deprecated.

(Since 10.2) Use getTargetAssociations()

Gets the value of the attribute: targetAssociations.

Supported API: true

Returns:

Collection

getTargetAssociations

protected Collection<ESITargetAssociation> getTargetAssociations()

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

Supported API: true

Returns:

Collection

getHolder

protected MPMOperationHolder getHolder()

Gets the value of the attribute: root.

Supported API: true

Returns:

MPMOperationHolder

getPrevRev

protected MPMOperationHolder getPrevRev()

Gets the value of the attribute: wcAdapter.

Supported API: true

Returns:

String

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Builds the output group for the work instruction for each MPMOperation and BOM associated with Process Plan. This consists of querying for MPMOperation's attributes, mapping them to the output and adding the resulting I*E Element to the VdbBuilder instance.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

setData

@Deprecated
public void setData(MPMOperationHolder holder,
 MPMOperationHolder prevRev,
 Collection<ESITargetAssociation> tgtAssociations,
 ViewReference defaultView)
             throws WTException

Deprecated.

Use setData(MPMOperationHolder, MPMOperationHolder, Collection, ViewReference, Collection) instead.

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

holder - Operation for which to render work instructions.

prevRev - Operation iteration that was previously published to the targets in orgs.

tgtAssociations - Collection of ESITargetAssociation objects.

defaultView - ViewReference object representing the Windchill view that the process plan (holding the operation) resides in.

Throws:

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

setData

public void setData(MPMOperationHolder holder,
 MPMOperationHolder prevRev,
 Collection<ESITargetAssociation> tgtAssociations,
 ViewReference defaultView,
 Collection<WTPart> partSet)
             throws WTException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

holder - Operation for which to render work instructions.

prevRev - Operation iteration that was previously published to the targets in tgtAssociations.

tgtAssociations - Collection of ESITargetAssociation objects.

defaultView - ViewReference object representing the Windchill view that the process plan (holding the operation) resides in.

partSet - Collection of parts associated with the process plan, if any.

Throws:

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

adjustElement

public com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 MPMOperationHolder currHolder,
 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 - - The element to be updated.

group - - The logical name of the group to which the element will be added.

currHolder - - Operation for which to render work instructions.

targets - - Collection of ESITarget objects.

Returns:

Element Info*Engine element containing the response data of work instruction corresponding to input operation holder.

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

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.