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

Class ESIPartToProcessPlanLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.mpml.processplan.ESIPartToProcessPlanLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIPartToProcessPlanLinkRenderer
extends BasicESIRenderer

Renders com.ptc.windchill.mpml.processplan.MPMPartToProcessPlanLink objects.

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, MPMPartToProcessPlanLink partToProcessPlanLink, 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 ProcessPlan Part Links.
protected MPMProcessPlan	getRoot()	Gets the value of the attribute: root.
protected String	getWcAdapter()	Deprecated. Deprecated at 10.2 M020.
void	setData(MPMProcessPlan root, Collection<MPMPartToProcessPlanLink>[] usageLinks, boolean useSavedFilterForPPPartLinks, Collection<ESITargetAssociation> targetAssociations, String auth, String wcAdapter)	Set this renderer's member variables that are necessary for rendering part to process plan links.
void	setData(MPMProcessPlan root, Collection<MPMPartToProcessPlanLink>[] usageLinks, Collection<ESITargetAssociation> targetAssociations, String auth, String wcAdapter)	Set this renderer's member variables that are necessary for rendering part to process plan links.
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, 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

getRoot

protected MPMProcessPlan getRoot()

Gets the value of the attribute: root.

Supported API: true

Returns:

MPMProcessPlan

getWcAdapter

@Deprecated
protected String getWcAdapter()

Deprecated.

Deprecated at 10.2 M020. 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 ProcessPlan Part Links. It creates a collection of all the added, changed and unchanged parts 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(MPMProcessPlan root,
 Collection<MPMPartToProcessPlanLink>[] usageLinks,
 Collection<ESITargetAssociation> targetAssociations,
 String auth,
 String wcAdapter)
             throws WTException

Set this renderer's member variables that are necessary for rendering part to process plan links.

Supported API: true

Parameters:

root - - Process plan for which part to process plan links need to be rendered.

usageLinks - - Collection of part to process plan links.

targetAssociations - - Collection of target associations.

auth - - Info*Engine authentication information to use when invoking 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.

setData

public void setData(MPMProcessPlan root,
 Collection<MPMPartToProcessPlanLink>[] usageLinks,
 boolean useSavedFilterForPPPartLinks,
 Collection<ESITargetAssociation> targetAssociations,
 String auth,
 String wcAdapter)
             throws WTException

Set this renderer's member variables that are necessary for rendering part to process plan links.

Supported API: true

Parameters:

root - - Process plan for which part to process plan links need to be rendered.

usageLinks - - Collection of part to process plan links.

useSavedFilterForPPPartLinks - - Specifies whether or not the Saved Filter should be applied while fetching part to process plan links.

targetAssociations - - Collection of target associations.

auth - - Info*Engine authentication information to use when invoking 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.

adjustElement

public com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 MPMPartToProcessPlanLink partToProcessPlanLink,
 Collection<ESITarget> 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.

partToProcessPlanLink - - part to process plan link.

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, 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.