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, Serializable

public class ESIBOMHeaderRenderer
extends BasicESIRenderer
implements Serializable

This class renders the output of BOM header (ie. ) in ESI DataResponse.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element element, String group, WTPart part, Eff[] effs, Collection targets) Supported API: true
protected com.infoengine.object.factory.Element	adjustElement(com.infoengine.object.factory.Element elem, String group, WTPart part, Eff eff, Collection 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	getTargets() Gets the value of the attribute: targets; A collection ESITarget objects.
protected void	validate() Make sure part, groupName, and targets are correct.

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

adjustDateEffectivities, adjustEffectivities, adjustEffectivities, adjustLotNumberEffCxt, adjustLotNumberEffectivities, adjustObjectID, adjustSerialNumberEffCxt, adjustSerialNumberEffectivities, adjustTargets, buildUfidString, getBuilder, invokeQueryTask, invokeQueryTask, invokeQueryTask, mapElement, mapObject, mapObject, render, setBuilder

Methods inherited from class java.lang.Object

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

Method Detail

getTargets

protected Collection getTargets()

Gets the value of the attribute: targets; A collection ESITarget 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,
                                                              Eff eff,
                                                              Collection targets)
                                                       throws com.ptc.windchill.esi.rnd.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 argument.

Supported API: true

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.

eff - May be null.

targets - Collection of ESITarget objects.

Returns:

Element

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element,
                                                              String group,
                                                              WTPart part,
                                                              Eff[] effs,
                                                              Collection targets)
                                                       throws com.ptc.windchill.esi.rnd.ESIRendererException

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:

com.ptc.windchill.esi.rnd.ESIRendererException

validate

protected void validate()
                 throws com.ptc.windchill.esi.rnd.ESIRendererException

Make sure part, groupName, and targets are correct.

Supported API: true

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

buildGroups

protected void buildGroups()
                    throws com.ptc.windchill.esi.rnd.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:

com.ptc.windchill.esi.rnd.ESIRendererException