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

Class ESIOperationRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

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

All Implemented Interfaces:

ESIRenderer

public class ESIOperationRenderer
extends BasicESIRenderer

This class renders an MPMOperation object.

Supported API: true

Extendable: true

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	ESIOperationRenderer.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
void	buildGroups()	Populates the associated VdbBuilder instance with the response data for an operation Supported API: true
Collection<WTPartMaster>	getOperatedOnPartMasters()	Returns the part masters associated on operated on part links.
protected Collection<MPMOperation>	getOperations()	Gets the value of the attribute: operations.
Map<MPMOperation,MPMOperation>	getOperationToPreviousIterationInfos()	Returns a Map holding the currently processed operation iterations as keys and the previously published operation iterations as values.
protected HashSet<WTPart>	getPartSet()	Gets the value of the attribute: partSet.
protected Map<ESIOperationRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>>	getPreviousExportedIterationAssociations(Collection<ESITargetAssociation> currentTgtAssns, boolean delta)	Populates a map that associates each previous exported iteration with a collection of 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 int	getSuboperationDepth()	Gets the value of the attribute: suboperationDepth.
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	isDocument()	Gets the value of the attribute: document.
protected boolean	isResource()	Gets the value of the attribute: resource.
void	setData(MPMOperationHolder root, MPMProcessPlan processPlan, HashSet<WTPart> partSet, Set<WTPart> dissociatedParts, Collection<MPMOperation> operations, boolean delta, int suboperationDepth, boolean resource, boolean standardProcedures, boolean document, boolean workInstruction, boolean operatedOnPart, boolean lineNumbers, String configSpec, Collection<ESITargetAssociation> targetAssocs, String auth, String wcAdapter, int transactionID, ViewReference defaultView, MPMProcessPlan prevExportedProcessPlanIteration)	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

getOperations

protected Collection<MPMOperation> getOperations()

Gets the value of the attribute: operations.

Supported API: true

Returns:

Collection

getRoot

protected MPMOperationHolder getRoot()

Gets the value of the attribute: root.

Supported API: true

Returns:

MPMOperationHolder

getSuboperationDepth

protected int getSuboperationDepth()

Gets the value of the attribute: suboperationDepth.

Supported API: true

Returns:

int

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.

isResource

protected boolean isResource()

Gets the value of the attribute: resource.

Supported API: true

Returns:

boolean

isDocument

protected boolean isDocument()

Gets the value of the attribute: document.

Supported API: true

Returns:

boolean

getTransactionId

protected int getTransactionId()

Gets the value of the attribute: transactionId.

Supported API: true

Returns:

int

getPartSet

protected HashSet<WTPart> getPartSet()

Gets the value of the attribute: partSet.

Supported API: true

Returns:

HashSet<WTPart>

buildGroups

public void buildGroups()
                 throws ESIRendererException

Populates the associated VdbBuilder instance with the response data for an operation

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

setData

public void setData(MPMOperationHolder root,
 MPMProcessPlan processPlan,
 HashSet<WTPart> partSet,
 Set<WTPart> dissociatedParts,
 Collection<MPMOperation> operations,
 boolean delta,
 int suboperationDepth,
 boolean resource,
 boolean standardProcedures,
 boolean document,
 boolean workInstruction,
 boolean operatedOnPart,
 boolean lineNumbers,
 String configSpec,
 Collection<ESITargetAssociation> targetAssocs,
 String auth,
 String wcAdapter,
 int transactionID,
 ViewReference defaultView,
 MPMProcessPlan prevExportedProcessPlanIteration)
             throws WTException

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

Supported API: true

Parameters:

root - - Root object of the operations being rendered. This could be an operation, a sequence or a process plan.

processPlan - - Process plan being rendered. If the operation being rendered is an immediate child of the process plan then the parameters "root" and "processPlan" refer to the same object.

partSet - - Set of parts associated with the currently published process plan iteration.

dissociatedParts - - Set of parts that were associated with a previously published process plan iteration, but not with the currently published iteration.

operations - - Collection of operations being rendered.

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

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

resource - - If true, returns the resources.

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

document - - If true, returns the documents associated with the operations.

workInstruction - - If true, returns work instructions.

operatedOnPart - - If true, returns the operated on parts associated with the operations.

lineNumbers - - If true, renders the line number information.

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 - - Name of the Windchill adapter instance to use when executing a webject.

transactionID - - ID of the underlying ESI transaction.

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

prevExportedProcessPlanIteration - - Previously Exported Iteration of Process plan.

Throws:

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

getOperatedOnPartMasters

public Collection<WTPartMaster> getOperatedOnPartMasters()
                                                  throws WTException

Returns the part masters associated on operated on part links.

Supported API: true

Returns:

Collection the collection of part master

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<ESIOperationRenderer.PreviousExportedIterationKey,Collection<ESITargetAssociation>> getPreviousExportedIterationAssociations(Collection<ESITargetAssociation> currentTgtAssns,
 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:

currentTgtAssns - - Collection of ESITargetAssociation

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 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 being rendered. Check the java doc of this renderer for more information.

Supported API: true

Returns:

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

getOperationToPreviousIterationInfos

public Map<MPMOperation,MPMOperation> getOperationToPreviousIterationInfos()

Returns a Map holding the currently processed operation iterations as keys and the previously published operation iterations as values. The Map can hold one or more null values if the corresponding operation iterations existing as keys have no previously published operation iterations.

Supported API: true

Returns:

- A Map as outlined in the description.