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. ) in ESI DataResponse.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private String	auth
private WTChangeOrder2	changeOrder
private static String	CLASSNAME
protected static String	MAP_FILE_PATH
protected static String	QUERY_TASK
private static String	RESOURCE
private Collection	targets
private TaskHelper	taskHelper
private ESITransactionUtility	txnUtility
private String	wcAdapter
protected static String	wcAttList

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

adapterName, PART_CLASS_NAME, TASK_URI, XML_META_NAME

Constructor Summary

ESIECNHeaderRenderer()

Method Summary

protected Element	adjustElement(Element element, String group, WTChangeOrder2 changeOrder, Collection targets) Allow subclasses to fix the contents of an element.
protected void	buildGroups() Map the input and save the resulting group in the VDB Supported API: false
private void	changeOrderValidate(WTChangeOrder2 a_ChangeOrder)
protected String	getAuth() Gets the value of the attribute: auth; The authentication to use when invoking a query task.
WTChangeOrder2	getChangeOrder() Gets the object for the association that plays role: changeOrder.
protected Element	getQueryObjectElement(WTChangeOrder2 changeOrder)
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.
private boolean	hasReleased(ESITarget target) check if the object has been released successfully.
protected Element	mapElement(String groupName, Element element, WTChangeOrder2 changeOrder, Collection targets)
void	setChangeOrder(WTChangeOrder2 a_ChangeOrder) Sets the object for the association that plays role: changeOrder.
void	setData(WTChangeOrder2 chgOrder, Collection targets, String auth, String wcAdapter) Provide the data required for the renderer to operate properly.
protected void	validate() Make sure targets and changeOrder attribute are OK.

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

adjustEffectivities, adjustObjectID, adjustTargets, buildUfidString, getAdapterName, getAttsFromMapFile, getBuilder, getEffectivityHandler, getGroupInfo, getMap, getMapInfo, getTargetsFromAssns, getWCAttributeList, invokeQueryTask, invokeQueryTask, invokeQueryTask, mapElement, mapObject, render, setBuilder, setEffectivityHandler

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

targets

private Collection targets

auth

private String auth

wcAdapter

private String wcAdapter

changeOrder

private WTChangeOrder2 changeOrder

QUERY_TASK

protected static final String QUERY_TASK

MAP_FILE_PATH

protected static final String MAP_FILE_PATH

taskHelper

private TaskHelper taskHelper

txnUtility

private ESITransactionUtility txnUtility

wcAttList

protected static String wcAttList

Constructor Detail

ESIECNHeaderRenderer

public ESIECNHeaderRenderer()

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

getChangeOrder

public WTChangeOrder2 getChangeOrder()

Gets the object for the association that plays role: changeOrder.

Supported API: false

Returns:

WTChangeOrder2

setChangeOrder

public void setChangeOrder(WTChangeOrder2 a_ChangeOrder)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: changeOrder.

Supported API: false

Parameters:

a_ChangeOrder -

Throws:

WTPropertyVetoException

changeOrderValidate

private void changeOrderValidate(WTChangeOrder2 a_ChangeOrder)
                          throws WTPropertyVetoException

Parameters:

a_ChangeOrder -

Throws:

WTPropertyVetoException

setData

public void setData(WTChangeOrder2 chgOrder,
                    Collection 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 targets and changeOrder attribute are OK.

Supported API: false

Specified by:

validate in class BasicESIRenderer

Throws:

ESIRendererException

buildGroups

protected void buildGroups()
                    throws ESIRendererException

Map the input and save the resulting group in the VDB

Supported API: false

Specified by:

buildGroups in class BasicESIRenderer

Throws:

ESIRendererException

adjustElement

protected Element adjustElement(Element element,
                                String group,
                                WTChangeOrder2 changeOrder,
                                Collection 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

mapElement

protected Element mapElement(String groupName,
                             Element element,
                             WTChangeOrder2 changeOrder,
                             Collection targets)
                      throws ESIRendererException

Throws:

ESIRendererException

getQueryObjectElement

protected Element getQueryObjectElement(WTChangeOrder2 changeOrder)
                                 throws WTException

Throws:

WTException

hasReleased

private boolean hasReleased(ESITarget target)
                     throws ESIRendererException

check if the object has been released successfully.

Throws:

ESIRendererException