Class AbstractResourceRenderer
java.lang.Object
com.ptc.windchill.esi.rnd.BasicESIRenderer
com.ptc.windchill.esi.enterprisedata.ESIAbstractEDRenderer
com.ptc.windchill.esi.rnd.ESIAbstractStructureRenderer
com.ptc.windchill.esi.mpml.resource.AbstractResourceRenderer
- All Implemented Interfaces:
ESIRenderer,com.ptc.windchill.esi.translation.ESITranslationRenderer
- Direct Known Subclasses:
ESIPlantStructureRenderer,ESIProcessMaterialRenderer,ESIResourceGroupStructureRenderer,ESISkillRenderer,ESIToolingRenderer,ESIWorkCenterRenderer
public abstract class AbstractResourceRenderer
extends ESIAbstractStructureRenderer
implements com.ptc.windchill.esi.translation.ESITranslationRenderer
Supported API: true
Extendable: false
-
Field Summary
Fields inherited from class com.ptc.windchill.esi.rnd.ESIAbstractStructureRenderer
ADDED_STRUCTURE, allRenderedBOMsSet, businessRuleSet, CHANGED_STRUCTURE, delta, documents, factory, lineNumbers, navigator, obid, publishProductionBOM, referenceDesignators, rootPart, transactionID, UNCHANGED_STRUCTUREFields 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 TypeMethodDescriptionprotected com.infoengine.object.factory.ElementadjustElement(com.infoengine.object.factory.Element element, String group, MPMResource plant, MPMPlantOwned plantOwnedObj, Collection<ESITarget> targets) Deprecated.protected com.infoengine.object.factory.ElementadjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, MPMOperationHolder mpmOperationHolder, MPMPlantOwned mpmPlantOwned, MPMResource resourceParent, Eff[] effs, Collection<ESITarget> targets) Allow subclasses to fix the contents of an element before it's added to the output group(s).protected com.infoengine.object.factory.ElementadjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, MPMResource parentResource, MPMPlantOwned plantOwned, Collection<ESITarget> targets) Deprecated.protected com.infoengine.object.factory.ElementadjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, MPMResource parentResource, Eff[] effs, Collection<ESITarget> targets) Deprecated.protected com.infoengine.object.factory.ElementadjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, Eff[] effs, Collection<ESITarget> targets) Deprecated.protected PersistablegetContextToFetchOptionSetInfo(MPMOperation mpmOperation, MPMResource mpmResource) Returns the context object to be used for fetching the option set information.protected intDeprecated.UseESIAbstractStructureRenderer.getMultiLevel()instead of this API.protected Collection<MPMResource> Gets the value of the attribute: mpmResources.protected MPMOperationReturns the operation which is consuming the MPMResources being rendered.protected MPMOperationHolderGets the value of the attribute: root.Gets the value of the attribute: plantOwned.protected Collection<ESITargetAssociation> getPreviousExportedIterations(Collection<ESITargetAssociation> currTargetAssoc, String releaseClass) Returns the previous exported iteration for each resource group and target combination from the input target associations.protected abstract ClassReturns the resource class of currently rendering resource.Gets the value of the attribute: resourceParent.protected abstract StringReturns the resource type ID of currently rendering resource.protected PersistablegetRootToFetchOptionSetInfo(MPMOperationHolder mpmOperationHolder, MPMResource mpmResource) Returns the root object to be used for fetching the option set information.protected abstract StringReturns the task URI.Returns collection of target associations.protected intDeprecated.Use} instead of this API.invalid @link
{@link #voidsetData(MPMPlantOwned plantOwnedObj, Collection<MPMResource> mpmResources, boolean publishDocuments, boolean delta, int levels, Collection<ESITargetAssociation> tgtAssociations, String auth, String adapter) Set this renderer's member variables that are necessary for rendering plants i.e.voidsetData(MPMOperationHolder root, MPMPlantOwned plantOwned, MPMResource resourceParent, Collection<MPMResource> mpmResources, Collection<ESITargetAssociation> processPlanTargetAssocs, boolean buildDocs, boolean delta, int levels, TreeNavigator treeNavigator, String auth, String wcAdapter, int transactionID, MPMOperation operation) Establish the renderer's state so that it can process requests.voidsetData(MPMOperationHolder root, MPMPlantOwned plantOwned, MPMResource resourceParent, Collection<MPMResource> mpmResources, Collection<ESITargetAssociation> processPlanTargetAssocs, boolean buildDocs, String auth, String wcAdapter, int transactionID, MPMOperation operation) voidsetData(MPMOperationHolder root, Collection<MPMResource> mpmResources, Collection<ESITargetAssociation> processPlanTargetAssocs, boolean buildDocs, String auth, String wcAdapter, int transactionID) Deprecated.Deprecated at 10.2 M010.protected voidsetOperation(MPMOperation operation) Sets the operation which is consuming the tooling objects being rendered.protected voidvalidate()Make sure the object is ready to process.Methods inherited from class com.ptc.windchill.esi.rnd.ESIAbstractStructureRenderer
applyBussinessRuleSetToAssemlyNodes, filterNonProductionAssemblyNodes, getAllRenderedBOMsSet, getBasePart, getMultiLevel, getObid, getRootPart, getTreeNavigator, getWcAdapter, isDelta, isDocuments, isLineNumbers, isReferenceDesignators, setMultiLevelMethods inherited from class com.ptc.windchill.esi.enterprisedata.ESIAbstractEDRenderer
adjustElementForPartVersions, adjustEnterpriseDataElement, adjustPFDElement, clearAdjustedPartGroupAfterMapping, configureED, getAddedGroupName, getAdjustedPartGroupAfterMapping, getChangedGroupName, getEnterpriseDataElementMap, getEnterpriseDataElementMap, getEnterpriseDataPlantFunctionalDataElementMap, getEnterpriseDataPlantFunctionalDataElementMap, getUnchangedGroupName, mapEnterpriseData, setAdjustedPartGroupAfterMappingMethods inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer
addAtt, adjustConfigurableAndCollapsibleAtts, adjustDateEffCxt, adjustDateEffectivities, adjustEffectivities, adjustLotNumberEffCxt, adjustLotNumberEffectivities, adjustObjectID, adjustSerialNumberEffCxt, adjustSerialNumberEffectivities, adjustTargets, buildGroups, 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, storeCurrentAndItsPreviousObjectMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.ptc.windchill.esi.translation.ESITranslationRenderer
adjustElementForTranslationSpecificAttrs
-
Method Details
-
getOperationHolder
Gets the value of the attribute: root.
Supported API: true- Returns:
- MPMOperationHolder
-
getMpmResources
Gets the value of the attribute: mpmResources.
Supported API: true- Returns:
- Collection
-
getPlantOwned
Gets the value of the attribute: plantOwned.
Supported API: true- Returns:
- the plantOwned
-
getResourceParent
Gets the value of the attribute: resourceParent.
Supported API: true- Returns:
- the resourceParent
-
getTransactionID
Deprecated.Use} instead of this API.invalid @link
{@link #
Supported API: trueGets the value of the attribute: transactionID.- Returns:
- int
-
getLevels
Deprecated.Gets the value of the attribute: multilevel; How many levels are we to traverse when extracting multi-level BOMs?- Returns:
- int
-
setData
public void setData(MPMPlantOwned plantOwnedObj, Collection<MPMResource> mpmResources, boolean publishDocuments, boolean delta, int levels, Collection<ESITargetAssociation> tgtAssociations, String auth, String adapter) throws ESIRendererException Set this renderer's member variables that are necessary for rendering plants i.e.MPMPlantobjects.
Supported API: true- Parameters:
plantOwnedObj- - Object to which the plants are assigned. part/process plan etc.publishDocuments- - Indicates whether or not the documents attached to the plant be published.levels- - Number of levels to be navigated.tgtAssociations- - Collection of target associations.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.plants- - Collection of plants which are to be rendered.publishDelta- - Indicates whether or not the difference in the plant be calculated. A false indicates the plant should be published as a added object though it is a changed object as per the release history.- Throws:
ESIRendererException- if any exception thrown by an ESIRenderer.
-
setData
@Deprecated public void setData(MPMOperationHolder root, MPMPlantOwned plantOwned, MPMResource resourceParent, Collection<MPMResource> mpmResources, Collection<ESITargetAssociation> processPlanTargetAssocs, boolean buildDocs, String auth, String wcAdapter, int transactionID, MPMOperation operation) Deprecated.UsesetData(MPMOperationHolder, MPMPlantOwned, MPMResource, Collection, Collection, boolean, boolean, int, TreeNavigator, String, String, int, MPMOperation)instead of this API.
Supported API: trueEstablish the renderer's state so that it can process requests.- Parameters:
root- - Top level process plan being rendered.plantOwned- - process plan/part to which the plant is associated. Not null only when the process materials in the input "processMaterials" argument are part of plant structure.resourceParent- - Plant/resource group in which the process material objects in the input argument "processMaterials" resides.processPlanTargetAssocs- Collection of target associations for the process plan.
Note: This parameter is currently not used.buildDocs- -Specifies whether or not documents associated with the process materials are to be returned by the renderer.auth- - Info*Engine authentication information to use when executing a query task.wcAdapter- - Windchill adapter instance name to use when executing a webject.transactionID- - ID of the underlying ESI transaction.operation- -MPMOperationobject which is consuming the resources being rendered.processMaterials- - Collection of process material objects to process.
-
setOperation
Sets the operation which is consuming the tooling objects being rendered.
Supported API: true- Parameters:
operation- - operation
-
getOperation
Returns the operation which is consuming the MPMResources being rendered.
Supported API: true- Returns:
- the mpm operation which is consuming the MPMResources being rendered.
-
validate
Make sure the object is ready to process. If authentication or adapterName is null, throws an exception.
Supported API: true- Specified by:
validatein classBasicESIRenderer- Throws:
ESIRendererException- if any exception thrown by an ESIRenderer.
-
getTgtAssociations
Returns collection of target associations.
Supported API: true- Returns:
- the tgtAssociations
-
adjustElement
protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, MPMOperationHolder mpmOperationHolder, MPMPlantOwned mpmPlantOwned, MPMResource resourceParent, Eff[] effs, 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:
element- - The element to be updated.group- - The logical name of the group to which the element will be added.mpmResource- - MPMResource being processed.mpmOperationHolder- - Top level process plan being rendered.mpmPlantOwned- - process plan/part to which the plant is associated. Not null only when the input mpmResource is part of plant structure.resourceParent- - Plant/resource group in which the input mpmResource object resides.targets- - Collection of ESITarget objects associated with the mpmResource.eff- - Effectivity associated with mpmResource.- Returns:
- Element
- Throws:
ESIRendererException- if any exception thrown by an ESIRenderer.
-
adjustElement
@Deprecated protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, MPMResource parentResource, MPMPlantOwned plantOwned, Collection<ESITarget> targets) throws ESIRendererException Deprecated.UseadjustElement(Element, String, MPMResource, MPMOperationHolder, MPMPlantOwned, MPMResource, Eff[], Collection)instead of this API.
Supported API: trueAllow subclasses to fix the contents of an element before it's added to the output group(s). Default behavior is to return the argument.- Parameters:
element- - The element to be updated.plantOwned- - The plant owing object for the resource grou could be process plan or MBOM parttargets- Collection targets.groupName- - The logical name of the group to which the element will be added.resourceGroup- - The resource group.parentReource- - The parent rsource viz. plant, resource group under which resource group is defined.- Returns:
- Updated element.
- Throws:
ESIRendererException
-
adjustElement
@Deprecated protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, MPMResource parentResource, Eff[] effs, Collection<ESITarget> targets) throws ESIRendererException Deprecated.UseadjustElement(Element, String, MPMResource, MPMOperationHolder, MPMPlantOwned, MPMResource, Eff[], Collection)instead of this API.
Supported API: trueAllow subclasses to fix the contents of an element before it's added to the output group(s). Default behavior is to return the argument.- Parameters:
element- - The element to be updated.group- - The logical name of the group to which the element will be added.parentResource- - Plant/ResourceGroup/WorkCenter under which this work center is defined.targets- - Collection of ESITarget objects associated with the work center.mpmWorkCenter- - Work center being processed.eff- - Effectivity associated with work center.- Returns:
- Element
- Throws:
ESIRendererException- if any exception thrown by an ESIRenderer.
-
adjustElement
@Deprecated protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element, String group, MPMResource plant, MPMPlantOwned plantOwnedObj, Collection<ESITarget> targets) throws ESIRendererException Deprecated.UseadjustElement(Element, String, MPMResource, MPMOperationHolder, MPMPlantOwned, MPMResource, Eff[], Collection)instead of this API.
Supported API: trueAllow subclasses to fix the contents of an element before it's added to the output group(s). Default behavior is to return the argument.- Parameters:
element- - The element to be updated.plant- - plantplantOwnedObj- process plan/part to which the input plant is associated.targets- Collection targets.groupName- - The logical name of the group to which the element will be added.- Returns:
- Updated element.
- Throws:
ESIRendererException
-
adjustElement
@Deprecated protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element, String group, MPMResource mpmResource, Eff[] effs, Collection<ESITarget> targets) throws ESIRendererException Deprecated.UseadjustElement(Element, String, MPMResource, MPMOperationHolder, MPMPlantOwned, MPMResource, Eff[], Collection)instead of this API.
Supported API: trueAllow subclasses to fix the contents of an element before it's added to the output group(s). Default behavior is to return the argument.- Parameters:
element- - The element to be updated.group- - The logical name of the group to which the element will be added.mpmResource- - MPMResource being processed.effs- - Effectivity associated with MPMResource.targets- - Collection of ESITarget objects associated with the MPMResource.- Returns:
- Element
- Throws:
ESIRendererException- if any exception thrown by an ESIRenderer.
-
getRootToFetchOptionSetInfo
protected Persistable getRootToFetchOptionSetInfo(MPMOperationHolder mpmOperationHolder, MPMResource mpmResource) 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 than the default one. It returns the input operation holder (top-level process plan) if it is not null, and the input mpmResource otherwise. The renderer "com.ptc.windchill.esi.ov.ChoiceMappableChoiceLinkRenderer" uses this object to find the appropriate option set for the current mpmResource being rendered. Check the java doc of this renderer for more information.
Supported API: true- Parameters:
mpmOperationHolder- - Top level process plan being rendered.mpmResource- - MPMResource being rendered.- Returns:
- Root object to be used for fetching the option set information.
-
getContextToFetchOptionSetInfo
protected Persistable getContextToFetchOptionSetInfo(MPMOperation mpmOperation, MPMResource mpmResource) Returns the context 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 context than the default one. It returns the input operation (which consumes the current mpmResource being rendered) if it is not null, and the input mpmResource otherwise. The renderer "com.ptc.windchill.esi.ov.ChoiceMappableChoiceLinkRenderer" uses this object to render appropriate context information in the response. Check the java doc of this renderer for more information.
Supported API: true- Parameters:
mpmOperation- - Operation which is consuming the input mpmResource being rendered.mpmResource- - MPMResource being rendered.- Returns:
- The object to be used for rendering context information in the response.
-
getPreviousExportedIterations
protected Collection<ESITargetAssociation> getPreviousExportedIterations(Collection<ESITargetAssociation> currTargetAssoc, String releaseClass) throws WTException Returns the previous exported iteration for each resource group and target combination from the input target associations. Simply returns the output of the the API.invalid reference
ESITransactionUtility#latestObjectExport(Collection, String)
Supported API: true- Parameters:
currTargetAssoc- - Collection of target associations. Typically, the target association between the resource group being processed and the current target.releaseClass- - ESI release class (E.g.: com.ptc.windchill.esi.mpml.ResourceGroup) to be used for fetching appropriateReleaseActivityobjects while computing the previous exported iterations.- Returns:
- Collection of target associations between the previous exported iteration and the current target.
- Throws:
WTException- if any of the invoked methods throws this exception.
-
setData
@Deprecated public void setData(MPMOperationHolder root, Collection<MPMResource> mpmResources, Collection<ESITargetAssociation> processPlanTargetAssocs, boolean buildDocs, String auth, String wcAdapter, int transactionID) Establish the renderer's state so that it can process requests.
Supported API: true- Parameters:
root- - Top level process plan being rendered.mpmResources- - Collection of mpmResources objects to process. May be empty.processPlanTargetAssocs- - Collection of target associations for the process plan.
Note: This parameter is currently not used.buildDocs- - Specifies whether or not documents associated with the mpmResource objects are to be returned by the renderer.auth- - Info*Engine authentication information to use when executing a query task.wcAdapter- - Windchill adapter instance name to use when executing a webject.transactionID- - ID of the underlying ESI transaction.
-
getResourceClass
Returns the resource class of currently rendering resource.
Supported API: true- Returns:
- The resource class of currently rendering resource. For example : In case of Plant, returns MPMPlant.class.
-
getTaskURI
Returns the task URI.
Supported API: true- Returns:
- The task URI.
-
getResourceTypeId
Returns the resource type ID of currently rendering resource.
Supported API: true- Returns:
- The resource type ID of currently rendering resource. For example : In case of Tooling, returns ESIConst.TOOLING_TYPEID.
-
adjustElement(Element, String, MPMResource, MPMOperationHolder, MPMPlantOwned, MPMResource, Eff[], Collection)instead of this API.