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

Class ESIResourceGroupStructureRenderer

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

All Implemented Interfaces:

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

public class ESIResourceGroupStructureRenderer
extends AbstractResourceRenderer

Renders the output of MPMResourceGroup (i.e. <ResourceGroup> </ResourceGroup>) in ESI DataResponse.

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 MPMResourceGroup objects as added, deleted, changed and unchanged objects appropriately. Delegates the work to ESIResourceUsageLinkRenderer, ESIResourceRenderer and ESIDocumentsRenderer to render the link between resource group and its children, the children in the resource group tree and the documents associated with the resource group respectively. Invokes the API MPMLUtility.compareMPMResource(MPMResource, MPMResource) to compute the difference between the current resource group and its previously successfully published iteration. Supported API: true
MPMResource	getParentResource()	Deprecated. Use AbstractResourceRenderer.getResourceParent() instead of this API.
Collection<MPMResourceGroup>	getResourceGroups()	Deprecated. Use AbstractResourceRenderer.getMpmResources() instead of this API.
protected void	validate()	Ensures that the data needed to execute this renderer is set appropriately using AbstractResourceRenderer.setData(com.ptc.windchill.mpml.processplan.operation.MPMOperationHolder, com.ptc.windchill.mpml.MPMPlantOwned, com.ptc.windchill.mpml.resource.MPMResource, java.util.Collection<com.ptc.windchill.mpml.resource.MPMResource>, java.util.Collection<com.ptc.windchill.esi.tgt.ESITargetAssociation>, boolean, boolean, int, com.ptc.windchill.esi.treenavigation.TreeNavigator, java.lang.String, java.lang.String, int, com.ptc.windchill.mpml.processplan.operation.MPMOperation) API.

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

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

buildGroups

protected void buildGroups()
                    throws ESIRendererException

1. Renders MPMResourceGroup objects as added, deleted, changed and unchanged objects appropriately.
2. Delegates the work to ESIResourceUsageLinkRenderer, ESIResourceRenderer and ESIDocumentsRenderer to render the link between resource group and its children, the children in the resource group tree and the documents associated with the resource group respectively.
3. Invokes the API MPMLUtility.compareMPMResource(MPMResource, MPMResource) to compute the difference between the current resource group and its previously successfully published iteration.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

See Also:

• BasicESIRenderer.buildGroups()

validate

protected void validate()
                 throws ESIRendererException

Ensures that the data needed to execute this renderer is set appropriately using AbstractResourceRenderer.setData(com.ptc.windchill.mpml.processplan.operation.MPMOperationHolder, com.ptc.windchill.mpml.MPMPlantOwned, com.ptc.windchill.mpml.resource.MPMResource, java.util.Collection<com.ptc.windchill.mpml.resource.MPMResource>, java.util.Collection<com.ptc.windchill.esi.tgt.ESITargetAssociation>, boolean, boolean, int, com.ptc.windchill.esi.treenavigation.TreeNavigator, java.lang.String, java.lang.String, int, com.ptc.windchill.mpml.processplan.operation.MPMOperation) API.

Supported API: true

Overrides:

validate in class AbstractResourceRenderer

Throws:

ESIRendererException - if any exception thrown by an ESIRenderer.

See Also:

• BasicESIRenderer.validate()

getParentResource

@Deprecated
public MPMResource getParentResource()

Deprecated.

Use AbstractResourceRenderer.getResourceParent() instead of this API.


Supported API: true

Returns the parent resource viz. plant, resource group under which this resource groups is defined.

Returns:

the plant

getResourceGroups

@Deprecated
public Collection<MPMResourceGroup> getResourceGroups()

Deprecated.

Use AbstractResourceRenderer.getMpmResources() instead of this API.

Supported API: true

Returns collection of resource groups which are to be rendered.

Returns:

the resource groups