Package com.ptc.windchill.esi.bom

Class ESIBOMHeaderRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.bom.ESIBOMHeaderRenderer

All Implemented Interfaces:

ESIRenderer

public class ESIBOMHeaderRenderer
extends BasicESIRenderer

This class renders the output of BOM header (i.e. <BOMHeader></BOMHeader>) in ESI DataResponse.

Supported API: true

Extendable: true

Field Summary

Fields inherited from class com.ptc.windchill.esi.rnd.BasicESIRenderer

adapterName, 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	adjustBOMHeaderElementForCP(com.infoengine.object.factory.Element element, WTPart part, WTPart header, CoProduceLink link)	Allows subclasses to fix the contents of the input Element before it is added to the output group(s).
protected com.infoengine.object.factory.Element	adjustBOMHeaderElementForMFS(com.infoengine.object.factory.Element element, WTPart part, WTPart header, RMAlternateLink link)	Allows subclasses to fix the contents of the input Element before it is added to the output group(s).
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, WTPart part, List<Eff>[] effs, Collection<ESITarget> targets)	Deprecated. Deprecated since 10.2 use adjustElement(Element, String, WTPart, Eff[], Collection) instead of this API Supported API: true
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element element, String group, WTPart part, Eff[] effs, Collection<ESITarget> targets)	Allow subclasses to fix the contents of an element before it's added to the output group(s).
protected void	buildGroups()	Builds the renderer output.
protected String	getGroupName()	Gets the value of the attribute: groupName; The logical name of a VdbGroup.
protected WTPart	getPart()	Gets the value of the attribute: part; The assembly part for this BOM.
protected Collection<ESITargetAssociation>	getTargetAssociations()	Gets the value of the attribute: targetAssociations; A collection ESITargetAssociation objects.
void	setData(String groupName, WTPart part, Collection<ESITargetAssociation> tgtAssociations, ESIEffectivityHandler effHandler)	Initializes this renderer instance appropriately.
void	setData(String groupName, WTPart part, Collection<ESITargetAssociation> tgtAssociations, ESIEffectivityHandler effHandler, String adapterName)	Initializes this renderer instance appropriately.
void	setData(String groupName, WTPart part, Collection<ESITargetAssociation> tgtAssociations, ESIEffectivityHandler effHandler, String auth, String adapterName)	Initializes this renderer instance appropriately.
void	setData(String groupName, WTPart part, Collection<ESITargetAssociation> tgtAssociations, WTPart basePart, ESIEffectivityHandler effHandler, ESITransactionUtility txnUtility, String auth, String adapterName)	Initializes this renderer instance appropriately.
protected void	validate()	Make sure part, groupName, and targetAssociations are correct.

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

getTargetAssociations

protected Collection<ESITargetAssociation> getTargetAssociations()

Gets the value of the attribute: targetAssociations; A collection ESITargetAssociation objects.

Supported API: true

Returns:

Collection

getGroupName

protected String getGroupName()

Gets the value of the attribute: groupName; The logical name of a VdbGroup.

Supported API: true

Returns:

String

getPart

protected WTPart getPart()

Gets the value of the attribute: part; The assembly part for this BOM.

Supported API: true

Returns:

WTPart

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element elem,
 String group,
 WTPart part,
 List<Eff>[] effs,
 Collection<ESITarget> targets)
                                                       throws ESIRendererException

Deprecated.

Deprecated since 10.2 use adjustElement(Element, String, WTPart, Eff[], Collection) instead of this API

Supported API: true

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.

Parameters:

elem - The element to be updated.

group - The logical name of the group to which the element will be added.

part - The assembly part that is being processed.

effs - May be null.

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element,
 String group,
 WTPart part,
 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 input element.

Supported API: true

Parameters:

element - The I*E element to be updated.

group - The logical name of the group to which the element will be added.

part - The assembly part that is relevant to the operation.

effs - Array of Effs containing the latest date, serial number and lot number effectivity values associated with the passed part.

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException

validate

protected void validate()
                 throws ESIRendererException

Make sure part, groupName, and targetAssociations are correct.

Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Builds the renderer output. Does the following:

1. Obtains the targets for part.
2. Maps the output.
3. Calls adjustObjectID() on the base class.
4. Calls adjustTargets() on the base class.
5. Calls adjustEffectivities() on the base class.
6. Calls adjustElement().
7. Passes the element to the VdbBuilder.

Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

setData

public void setData(String groupName,
 WTPart part,
 Collection<ESITargetAssociation> tgtAssociations,
 ESIEffectivityHandler effHandler)
             throws ESIRendererException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

groupName - Name of the group for which to render the output - for e.g., "AddedBOMs", "ChangedBOMs" etc.

part - WTPart instance that represents the BOM header for which to render the output.

tgtAssociations - Collection of ESITargetAssociations for the input BOM header.

effHandler - EffectivityHandler instance to be used for processing effectivity specifications on the BOM header.

Throws:

ESIRendererException

adjustBOMHeaderElementForMFS

protected com.infoengine.object.factory.Element adjustBOMHeaderElementForMFS(com.infoengine.object.factory.Element element,
 WTPart part,
 WTPart header,
 RMAlternateLink link)

Allows subclasses to fix the contents of the input Element before it is added to the output group(s). Default behavior is to return the input Element itself.

Supported API: true

Parameters:

header - - Parent part of Made from set object.

link - - Alternate made from link.

elem - - Info*Engine Element to be updated.

madeFromSet - - Made from set object.

Returns:

Element - Updated Element.

adjustBOMHeaderElementForCP

protected com.infoengine.object.factory.Element adjustBOMHeaderElementForCP(com.infoengine.object.factory.Element element,
 WTPart part,
 WTPart header,
 CoProduceLink link)

Allows subclasses to fix the contents of the input Element before it is added to the output group(s). Default behavior is to return the input Element itself.

Supported API: true

Parameters:

header - - Parent part of Co-roduce object.

link - - Co-produce link.

elem - - Info*Engine Element to be updated.

madeFromSet - - Co-produce object.

Returns:

Element - Updated Element.

setData

public void setData(String groupName,
 WTPart part,
 Collection<ESITargetAssociation> tgtAssociations,
 ESIEffectivityHandler effHandler,
 String adapterName)
             throws ESIRendererException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

groupName - Name of the group for which to render the output - for e.g., "AddedBOMs", "ChangedBOMs" etc.

part - WTPart instance that represents the BOM header for which to render the output.

tgtAssociations - Collection of ESITargetAssociations for the input BOM header.

effHandler - EffectivityHandler instance to use when processing effectivity specifications on the BOM header.

adapterName - Windchill adapter instance name to use when executing a webject.

Throws:

ESIRendererException

setData

public void setData(String groupName,
 WTPart part,
 Collection<ESITargetAssociation> tgtAssociations,
 ESIEffectivityHandler effHandler,
 String auth,
 String adapterName)
             throws ESIRendererException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

groupName - Name of the group for which to render the output - for e.g., "AddedBOMs", "ChangedBOMs" etc.

part - WTPart instance that represents the BOM header for which to render the output.

tgtAssociations - Collection of ESITargetAssociations for the input BOM header.

effHandler - EffectivityHandler instance to use when processing effectivity specifications on the BOM header.

auth - I*E authentication information to use when executing a query task.

adapterName - Windchill adapter instance name to use when executing a webject.

Throws:

ESIRendererException

setData

public void setData(String groupName,
 WTPart part,
 Collection<ESITargetAssociation> tgtAssociations,
 WTPart basePart,
 ESIEffectivityHandler effHandler,
 ESITransactionUtility txnUtility,
 String auth,
 String adapterName)
             throws ESIRendererException

Initializes this renderer instance appropriately.

Supported API: true

Parameters:

groupName - Name of the group for which to render the output - for e.g., "AddedBOMs", "ChangedBOMs" etc.

part - WTPart instance that represents the BOM header for which to render the output.

tgtAssociations - Collection of ESITargetAssociations for the input BOM header.

effHandler - EffectivityHandler instance to use when processing effectivity specifications on the BOM header.

txnUtility - ESITransactionUtility instance to use when fetching previously published part iterations.

auth - I*E authentication information to use when executing a query task.

adapterName - Windchill adapter instance name to use when executing a webject.

Throws:

ESIRendererException