Package com.ptc.windchill.esi.enterprisedata

Class ESIAbstractEDRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.enterprisedata.ESIAbstractEDRenderer

All Implemented Interfaces:

ESIRenderer

Direct Known Subclasses:

ESIAbstractStructureRenderer, ESIWTPartRenderer

public abstract class ESIAbstractEDRenderer
extends BasicESIRenderer

Renders the output of EnterpriseData in ESI response.

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
protected com.infoengine.object.factory.Element	adjustEnterpriseDataElement(String groupName, com.infoengine.object.factory.Element partElement, com.infoengine.object.factory.Element enterpriseDataElement, EnterpriseData enterpriseData, Collection targets)	Allows subclasses to fix the contents of an info engine element.
protected com.infoengine.object.factory.Element	adjustPFDElement(String groupName, com.infoengine.object.factory.Element partElement, com.infoengine.object.factory.Element enterpriseDataElement, EnterpriseData enterpriseData, com.ptc.windchill.enterprise.data.PlantFunctionalData plantFunctionalData, String description, Collection targets)	Allows subclasses to fix the contents of an info engine element.
protected abstract String	getAddedGroupName()	Returns the added group name for currently rendering resource.
protected abstract String	getChangedGroupName()	Returns the changed group name for currently rendering resource.
protected abstract String	getUnchangedGroupName()	Returns the unchanged group name for currently rendering resource.

Methods 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, storeCurrentAndItsPreviousObject, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

adjustEnterpriseDataElement

protected com.infoengine.object.factory.Element adjustEnterpriseDataElement(String groupName,
 com.infoengine.object.factory.Element partElement,
 com.infoengine.object.factory.Element enterpriseDataElement,
 EnterpriseData enterpriseData,
 Collection targets)

Allows subclasses to fix the contents of an info engine element.

Supported API: true

Parameters:

groupName - - Name of the group in ESI response for which to adjust the info engine element.

partElement - - WTPart element that is relevant to the operation.

enterpriseDataElement - - EnterpriseData info engine element whose contents need to be adjusted.

enterpriseData - - EnterpriseData that is relevant to the operation.

targets - - Collection of ESITarget objects.

Returns:

- The adjusted Element. OOTB API does not do any adjustments on input eleemnt

adjustPFDElement

protected com.infoengine.object.factory.Element adjustPFDElement(String groupName,
 com.infoengine.object.factory.Element partElement,
 com.infoengine.object.factory.Element enterpriseDataElement,
 EnterpriseData enterpriseData,
 com.ptc.windchill.enterprise.data.PlantFunctionalData plantFunctionalData,
 String description,
 Collection targets)

Allows subclasses to fix the contents of an info engine element.

Supported API: true

Parameters:

groupName - - Name of the group in ESI response for which to adjust the info engine element.

partElement - - WTPart element that is relevant to the operation.

enterpriseDataElement - - EnterpriseData info engine element whose contents need to be adjusted.

enterpriseData - - EnterpriseData that is relevant to the operation.

targets - - Collection of ESITarget objects.

PlantFunctionalData - - PlantFunctionalData that is relevant to the operation.

Description - - Description that is relevant to the operation.

Returns:

- The adjusted Element. OOTB API does not do any adjustments on input eleemnt

getAddedGroupName

protected abstract String getAddedGroupName()

Returns the added group name for currently rendering resource.

Supported API: true

Returns:

The added group name for currently rendering resource. For example : In case of Tooling, returns ESIConst.ADDED_TOOLING.

getChangedGroupName

protected abstract String getChangedGroupName()

Returns the changed group name for currently rendering resource.

Supported API: true

Returns:

The added group name for currently rendering resource. For example : In case of Tooling, returns ESIConst.CHANGED_TOOLING.

getUnchangedGroupName

protected abstract String getUnchangedGroupName()

Returns the unchanged group name for currently rendering resource.

Supported API: true

Returns:

The added group name for currently rendering resource. For example : In case of Tooling, returns ESIConst.UNCHANGED_TOOLING.