Package com.ptc.windchill.esi.aum

Class ESIAlternateUnitOfMeasureRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.aum.ESIAlternateUnitOfMeasureRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIAlternateUnitOfMeasureRenderer
extends BasicESIRenderer

Renders alternate unit of measure for AUM Holder AUM Holder object holding the Alternate Unit of Measure information - for e.g., it could be a WTPartMaster instance.

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	adjustElement(com.infoengine.object.factory.Element element, AlternateUnitOfMeasure aum)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups()	Queries AlternateUnitOfMeasure object associated with the holder and render it as current Alternate Unit Of Measure.
protected AlternateUnitAssignable	getAUMHolder()	Gets the value of the attribute: aumHolder.
protected String	getAUMHolderNumber()	Gets the value of the attribute: aumHolderNumber.
protected String	getAUMHolderType()	Gets the value of the attribute: aumHolderType.
void	setData(AlternateUnitAssignable aumHolder, String objectNumber, String type, Collection<ESITarget> targets)	Initializes this renderer instance appropriately.
protected void	validate()	This method is expected to examine the attributes of the object and throw an exception if they are not set properly.

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

getAUMHolder

protected AlternateUnitAssignable getAUMHolder()

Gets the value of the attribute: aumHolder.

Supported API: true

Returns:

AlternateUnitAssignable

getAUMHolderNumber

protected String getAUMHolderNumber()

Gets the value of the attribute: aumHolderNumber.

Supported API: true

Returns:

String

getAUMHolderType

protected String getAUMHolderType()

Gets the value of the attribute: aumHolderType.

Supported API: true

Returns:

String

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Queries AlternateUnitOfMeasure object associated with the holder and render it as current Alternate Unit Of Measure.

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException - When there is a exception while rendering AlternateUnitOfMeasure

Supported API: true

See Also:

• BasicESIRenderer.buildGroups()

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element,
 AlternateUnitOfMeasure aum)

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:

aum - - The AlternateUnitOfMeasure object to be mapped

Returns:

- The mapped aum element.

Throws:

ESIRendererException - When failed to map element for queried AlternateUnitOfMeasure object

setData

public void setData(AlternateUnitAssignable aumHolder,
 String objectNumber,
 String type,
 Collection<ESITarget> targets)
             throws ESIRendererException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

aumHolder - The object holding the Alternate Unit of Measure information - for e.g., it could be a WTPartMaster instance.

objectNumber - Number of the object holding AUM information.

type - Type of the object holding AUM information - for e.g., it could be "com.ptc.windchill.esi.Part".

targets - Collection of ESITarget objects to publish the AUM information to.

Throws:

ESIRendererException - When failed to set the state of the renderer before renderer starts rendering elements

validate

protected void validate()
                 throws ESIRendererException

This method is expected to examine the attributes of the object and throw an exception if they are not set properly.

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException - When there is a exception while rendering AlternateUnitOfMeasure

Supported API: true