com.ptc.windchill.esi.ecn
Class ESIChangeHeaderRenderer

java.lang.Object
  com.ptc.windchill.esi.rnd.ResponseRendererImpl
      com.ptc.windchill.esi.ecn.ESIChangeHeaderRenderer

All Implemented Interfaces:

ChangeHeaderRenderer, ResponseRenderer, Serializable

public class ESIChangeHeaderRenderer
extends ResponseRendererImpl
implements ChangeHeaderRenderer, Serializable

Manages the generation of an ECN header. This is the default implementation of ChangeHeaderRenderer.

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, WTChangeOrder2 changeOrder, Collection targets) Allow subclasses to fix the contents of an element.
protected String	getAuth() Gets the value of the attribute: auth; The authentication to use when invoking a query task.
protected Collection	getTargets() Gets the value of the attribute: targets; A collection of ESITarget objects that are of interest to the renderer.
protected String	getWcAdapter() Gets the value of the attribute: wcAdapter; The name of the Windchill adapter where query tasks will execute.
void	setData(WTChangeOrder2 chgOrder, Collection targets, String auth, String wcAdapter) Provide the data required for the renderer to operate properly.

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

adjustEffectivities, adjustObjectID, adjustTargets, buildUfidString, getBuilder, invokeQueryTask, mapElement, mapObject, render, setBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ptc.windchill.esi.rnd.ResponseRenderer

render

Method Detail

getTargets

protected Collection 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

getAuth

protected String getAuth()

Gets the value of the attribute: auth; The authentication to use when invoking a query task.

Supported API: true

Returns:

String

getWcAdapter

protected String getWcAdapter()

Gets the value of the attribute: wcAdapter; The name of the Windchill adapter where query tasks will execute.

Supported API: true

Returns:

String

setData

public void setData(WTChangeOrder2 chgOrder,
                    Collection targets,
                    String auth,
                    String wcAdapter)
             throws com.ptc.windchill.esi.rnd.ESIRendererException

Provide the data required for the renderer to operate properly.

Supported API: true

Specified by:

setData in interface ChangeHeaderRenderer

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:

com.ptc.windchill.esi.rnd.ESIRendererException

adjustElement

protected com.infoengine.object.factory.Element adjustElement(com.infoengine.object.factory.Element element,
                                                              String group,
                                                              WTChangeOrder2 changeOrder,
                                                              Collection targets)
                                                       throws com.ptc.windchill.esi.rnd.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:

com.ptc.windchill.esi.rnd.ESIRendererException