Package com.ptc.windchill.esi.mpml.resource

Class ESIResourceUsageLinkRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.bom.ESIBOMSubordinateRenderer

com.ptc.windchill.esi.bom.ESIBOMComponentRenderer

com.ptc.windchill.esi.mpml.resource.ESIResourceUsageLinkRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIResourceUsageLinkRenderer
extends ESIBOMComponentRenderer

Renders the output of WTPartUsageLink (i.e. <ResourceUsageLink> </ResourceUsageLink>) in ESI DataResponse.

Supported API: true

Extendable: true

Nested Class Summary

Nested classes/interfaces inherited from class com.ptc.windchill.esi.bom.ESIBOMComponentRenderer

ESIBOMComponentRenderer.AdjustActions

Field Summary

Fields inherited from class com.ptc.windchill.esi.bom.ESIBOMComponentRenderer

ADDED_BOM_COMPONENTS, CHANGED_BOM_COMPONENTS, DELETED_BOM_COMPONENTS, NULL_STRING, PART_USAGE_CLASS, RAW_MATERIAL_CLASS, UNCHANGED_BOM_COMPONENTS, VERSION_OBJECT_LINK_CLASS, wcAttList

Fields inherited from class com.ptc.windchill.esi.bom.ESIBOMSubordinateRenderer

currToPrevUsageLinks, delParts, part, partUsageLinksWithSubstitutes, partUsagesToTargetAssocsMap, renderedParts, rmDelParts, root, targetAssociations

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 groupName, WTPartUsageLink usageLink, MPMPlantOwned plantOwnedObj, MPMResource resource, WTPart roleBResource, Collection<ESITarget> targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected boolean	areLineNumbersEnforced()	getter for enforceLineNumbers attribute.
protected void	buildGroups()	Renders the usage link between two resources as added, deleted, changed and unchanged object appropriately.
void	setData(MPMPlantOwned plantOwnedObj, MPMResource resource, Map<WTPartUsageLink,WTPart>[] delta, Collection<ESITargetAssociation> tgtAssociations, String auth, String adapter)	Set this renderer's member variables that are necessary for rendering usage links i.e.
protected void	validate()	Ensures that the data needed to execute this renderer is set appropriately using setData(MPMPlantOwned, MPMResource, Map[], Collection, String, String) API.

Methods inherited from class com.ptc.windchill.esi.bom.ESIBOMComponentRenderer

adjustBOMComponents, adjustBOMComponents, adjustChangedBOMComponents, adjustDeletedCPLinkElement, adjustDeletedRawMaterialLinkElement, adjustElement, adjustElement, adjustElement, adjustMadeFromLinkElementsInBOMComponent, adjustUnitEffectivities, adjustUsageAndAlternate, buildACoProduceDeltaGroup, buildCoProduceDeltaGroups, compareUsageLinks, getAlternateMadeFromLinkForMFS, getBomPart, getComponentParts, getContextToFetchOptionSetInfo, getCoProduceDelta, getRootToFetchOptionSetInfo, getTreeNavigator, mapPartUsageInfo, mapRawMaterialLink, setBomPart, setComponentParts, setCoProduceDelta, setData, setData, setData, setData, setMadeFromSetMaps, setTreeNavigator

Methods inherited from class com.ptc.windchill.esi.bom.ESIBOMSubordinateRenderer

addRenderedPart, addRenderedPart, addRenderedPart, addRenderedPart, addRenderedParts, areComponentQuantitiesRequired, getAigManager, getCaller, getCurrToPrevUsageLinks, getDelParts, getDeltaParts, getPartUsageLinksWithSubstitutes, getRenderedParts, getRenderedParts, getRmDelParts, getRoot, getTargetAssocsForPartUsageLink, isDefaultFilter, isLineNumberEnabled, setData, setData, setData, setData, setData, setPartUsageLinksWithSubstitutes, setPartUsagesToTargetAssocsMap, setRoot, shouldConsolidateComponentQuantity

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

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders the usage link between two resources as added, deleted, changed and unchanged object appropriately.

Supported API: true

Overrides:

buildGroups in class ESIBOMComponentRenderer

Throws:

ESIRendererException

See Also:

• BasicESIRenderer.buildGroups()

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String groupName,
 WTPartUsageLink usageLink,
 MPMPlantOwned plantOwnedObj,
 MPMResource resource,
 WTPart roleBResource,
 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 - - The element to be updated.

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

usageLink - - Link between two resources.

plantOwnedObj - - process plan/part to which the input plant is associated.

resource - - Resource which is the RoleA of the input usage link.

roleBResource - RoleB iteration of the input usage link.

targets - - Collection targets.

Returns:

Updated element.

validate

protected void validate()
                 throws ESIRendererException

Ensures that the data needed to execute this renderer is set appropriately using setData(MPMPlantOwned, MPMResource, Map[], Collection, String, String) API.

Supported API: true

Overrides:

validate in class ESIBOMSubordinateRenderer

Throws:

ESIRendererException

See Also:

• BasicESIRenderer.validate()

setData

public void setData(MPMPlantOwned plantOwnedObj,
 MPMResource resource,
 Map<WTPartUsageLink,WTPart>[] delta,
 Collection<ESITargetAssociation> tgtAssociations,
 String auth,
 String adapter)
             throws ESIRendererException

Set this renderer's member variables that are necessary for rendering usage links i.e. WTPartUsageLink.

Supported API: true

Parameters:

plantOwnedObj - - Object to which the plants are assigned. part/process plan etc.

resource - - Resource which is the RoleA of the input usage links.

delta - - Collection of resource usage links i.e. WTPartUsageLink objects. The collection at index-0 is expected to contain the links which are newly added to the input resource object , index-1 deleted links, index-2 changed links and index-3 unchanged links.

tgtAssociations - - Collection of target assignments with the plant owned.

auth - - Info*Engine authentication information to be used when invoking a query task.

adapter - - Windchill adapter instance name to be used when executing a info*engine webject.

Throws:

ESIRendererException - - if any exception thrown by an ESIRenderer.

areLineNumbersEnforced

protected boolean areLineNumbersEnforced()

getter for enforceLineNumbers attribute.

Supported API: true

Overrides:

areLineNumbersEnforced in class ESIBOMSubordinateRenderer

Returns:

boolean