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

Class ESIToolingRenderer

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

com.ptc.windchill.esi.mpml.resource.ESIToolingRenderer

All Implemented Interfaces:

ESIRenderer, com.ptc.windchill.esi.translation.ESITranslationRenderer

public class ESIToolingRenderer
extends AbstractResourceRenderer

Renders the output of MPMTooling (i.e. <Tooling> </Tooling>) in ESI response.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class com.ptc.windchill.esi.mpml.resource.AbstractResourceRenderer

ADDED_MPM_RESOURCE, ADDED_RESOURCES_BOM, CHANGED_MPM_RESOURCE, CHANGED_RESOURCES_BOM, currentAndPreviousResourceMap, DELETED_RESOURCES_BOM, prevTargetAssoc, UNCHANGED_MPM_RESOURCE, UNCHANGED_RESOURCES_BOM

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_STRUCTURE

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 void	buildGroups()	Renders tooling objects as added, deleted, changed and unchanged objects appropriately.
protected Collection<MPMTooling>	getToolings()	Deprecated. Use AbstractResourceRenderer.getMpmResources() instead of this API.
protected void	processToolings(MPMResource toolingHeader, Collection<MPMResource> toolings, Collection<MPMResource>[] toolingColls, ESITarget tgt, TreeNavigator navigator)	Output generator for the class.

Methods inherited from class com.ptc.windchill.esi.mpml.resource.AbstractResourceRenderer

adjustElement, adjustElement, adjustElement, adjustElement, adjustElement, buildBOMHeader, buildMPMResource, getBOMAndPartCollection, getContextToFetchOptionSetInfo, getCurrentAndPreviousPublishedObjectMap, getEnforceOrgs, getLevels, getMpmResources, getOperation, getOperationHolder, getPlantOwned, getPreviousExportedIterations, getRendererForSubsOrAltBOM, getResourceParent, getRootToFetchOptionSetInfo, getTgtAssociations, getTransactionID, getTreeNavigator, mapMPMResourceElement, mapMPMResourceElement, processUsageLinks, renderAssocOptionSet, renderExpressions, renderLeafParts, setData, setData, setData, setData, setOperation, validate

Methods inherited from class com.ptc.windchill.esi.rnd.ESIAbstractStructureRenderer

applyBussinessRuleSetToAssemlyNodes, filterNonProductionAssemblyNodes, getAllRenderedBOMsSet, getBasePart, getMultiLevel, getObid, getRootPart, getTreeNavigator, getWcAdapter, isDelta, isDocuments, isLineNumbers, isReferenceDesignators, setMultiLevel

Methods inherited from class com.ptc.windchill.esi.enterprisedata.ESIAbstractEDRenderer

adjustElementForPartVersions, adjustEnterpriseDataElement, adjustPFDElement, clearAdjustedPartGroupAfterMapping, configureED, getAdjustedPartGroupAfterMapping, getEnterpriseDataElementMap, getEnterpriseDataElementMap, getEnterpriseDataPlantFunctionalDataElementMap, getEnterpriseDataPlantFunctionalDataElementMap, mapEnterpriseData, setAdjustedPartGroupAfterMapping

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

Methods inherited from interface com.ptc.windchill.esi.translation.ESITranslationRenderer

adjustElementForTranslationSpecificAttrs

Method Details

getToolings

@Deprecated
protected Collection<MPMTooling> getToolings()

Deprecated.

Use AbstractResourceRenderer.getMpmResources() instead of this API.


Supported API: true

Gets the value of the attribute: toolings.

Returns:

Collection

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders tooling objects as added, deleted, changed and unchanged objects appropriately.

1. Renders the tooling structures as structures(all the tooling objects in the structure including links) in the response.
2. All other tooling objects which are not structures will be rendered normally.
3. Uses the TreeNavigator instance passed as input via. setData() API to get the structure information. If it is null, invokes the API AbstractResourceRenderer.getTreeNavigator(MPMTooling) to navigate tooling structure.
4. Invokes the renderer ESIResourceUsageLinkRenderer to render the link WTPartUsageLink that exists between two resources.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

See Also:

• BasicESIRenderer.buildGroups()

processToolings

protected void processToolings(MPMResource toolingHeader,
 Collection<MPMResource> toolings,
 Collection<MPMResource>[] toolingColls,
 ESITarget tgt,
 TreeNavigator navigator)
                        throws ESIRendererException

Output generator for the class. Does the following:

1. Checks the target associations of input tooling objects. Throws exception and aborts response generation if a tooling object doesn't have targets associated and the enforce orgs preference has a value true.
2. Finds the most current released version of the tooling for the input target.
3. Compares the current version to the most current version. If they are the same and the effectivity has not changed, the tooling is rendered as unchanged object.
4. Calls the Windchill Adapter to obtain all the attributes of the tooling.
5. Maps the result of the Windchill Adapter call.
6. Calls adjustElement()
7. If documents are required, calls the document renderer.
8. If the tooling is a structure, collects the links appropriately and invokes the ESIResourceUsageLinkRenderer renderer to render them.

Supported API: true

Parameters:

toolingHeader - - Header of the tooling structure.

toolings - - Collection of tooling objects.

toolingColls - - An array of collections which holds the added, deleted, changed and unchanged tooling objects respectively.

tgt - - Current distribution target.

navigator - - Tree navigator instance to get the structure information.

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.