Package com.ptc.windchill.esi.ecn

Class ESIECNHeaderRenderer

java.lang.Object

com.ptc.windchill.esi.rnd.BasicESIRenderer

com.ptc.windchill.esi.ecn.ESIECNHeaderRenderer

All Implemented Interfaces:

ESIRenderer, Serializable

public class ESIECNHeaderRenderer
extends BasicESIRenderer
implements Serializable

This class renders the output of ECN header (ie. <ECNHeader></ECNHeader> ) in ESI DataResponse.

Supported API: true

Extendable: true

See Also:

• Serialized Form

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, String group, WTChangeOrder2 changeOrder, Collection<ESITarget> targets)	Allow subclasses to fix the contents of an element.
protected void	buildGroups()	Renders and populates VDB instance with Engineering Change Notice and its related objects. Supported API: true
protected Collection<ESITarget>	getTargets()	Gets the value of the attribute: targets; A collection of ESITarget objects that are of interest to the renderer.
protected boolean	hasChanged(WTChangeOrder2 changeOrder, ESITarget target)	Check if the change notice object has changed.
protected boolean	hasReleased(WTChangeOrder2 changeOrder, ESITarget target)	Check if the change notice object has been released successfully.
void	setData(WTChangeOrder2 chgOrder, Collection<ESITarget> targets, String auth, String wcAdapter)	Provide the data required for the renderer to operate properly.
protected void	validate()	Make sure that the attributes changeOrder and targets are valid.

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

getTargets

protected Collection<ESITarget> getTargets()

Gets the value of the attribute: targets; A collection of ESITarget objects that are of interest to the renderer.

Supported API: true

Returns:

Collection

setData

public void setData(WTChangeOrder2 chgOrder,
 Collection<ESITarget> targets,
 String auth,
 String wcAdapter)
             throws ESIRendererException

Provide the data required for the renderer to operate properly.

Supported API: true

Parameters:

chgOrder - The change order to be rendered.

targets - A collection of ESITarget objects that are of interest to the renderer.

auth - The authentication to use when invoking a query task.

wcAdapter - The name of the Windchill adapter where query tasks will execute.

Throws:

ESIRendererException

validate

protected void validate()
                 throws ESIRendererException

Make sure that the attributes changeOrder and targets are valid.

Supported API: true

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Renders and populates VDB instance with Engineering Change Notice and its related objects.


Supported API: true

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element,
 String group,
 WTChangeOrder2 changeOrder,
 Collection<ESITarget> targets)
                                                       throws ESIRendererException

Allow subclasses to fix the contents of an element.

Supported API: true

Parameters:

element -

group -

changeOrder -

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

ESIRendererException

hasReleased

protected boolean hasReleased(WTChangeOrder2 changeOrder,
 ESITarget target)
                       throws ESIRendererException

Check if the change notice object has been released successfully.

Supported API: true

Throws:

ESIRendererException

hasChanged

protected boolean hasChanged(WTChangeOrder2 changeOrder,
 ESITarget target)

Check if the change notice object has changed. OOTB this APi returns false.

Supported API: true