com.ptc.windchill.esi.ecn
Class ESIChangeOrder2Renderer

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

All Implemented Interfaces:

ChangeOrder2Renderer, ResponseRenderer

public class ESIChangeOrder2Renderer
extends ResponseRendererImpl
implements ChangeOrder2Renderer

Manages the generation of an ECN. This is the default implementation of ChangeOrder2Renderer.

Supported API: true

Extendable: true

Method Summary

protected void	buildGroups() Calls ESIChangeHeaderRenderer to create the ECN header group.
protected String	getAuth() Gets the value of the attribute: auth; Authentication information for Info*Engine tasks.
protected String	getConfigSpec() Gets the value of the attribute: configSpec; The Config Spec.
protected String	getMultiLevel() Gets the value of the attribute: multiLevel; The number of levels of BOM.
protected String	getObjectID() Gets the value of the attribute: objectID; The UFID of a WTChangeOrder 2.
protected String	getTransactionID() Gets the value of the attribute: transactionID; The number of the transaction to associate with the output from renderer.
protected String	getWcAdapter() Gets the value of the attribute: wcAdapter; The name of the Windchill adapter.
protected boolean	isAlternates() Gets the value of the attribute: alternates; When parts are exported, should the alternates of the parts (if any are defined) be exported? Supported API: true
protected boolean	isComponentParts() Gets the value of the attribute: componentParts; When BOMs are exported, should parts be created for BOM components? Supported API: true
protected boolean	isDelta() Gets the value of the attribute: delta; Should RPC responses contain only information that has changed since the last time objects were released? Supported API: true
protected boolean	isDocuments() Gets the value of the attribute: documents; If "true", returns associated documents info, default is "false".
protected boolean	isLineNumbers() Gets the value of the attribute: lineNumbers; If "true", returns line numbers info, otherwise no line numbers info is returned.
protected boolean	isReferenceDesignators() Gets the value of the attribute: referenceDesignators; If "true", returns Reference Designator data.
protected boolean	isSubstitutes() Gets the value of the attribute: substitutes; If "true", returns substitute data.
void	setData(String objectID, boolean delta, boolean componentParts, boolean alternates, boolean substitutes, boolean referenceDesignators, boolean lineNumbers, String mulitLevel, boolean documents, String configSpec, String auth, String wcAdapter, String transactionID) Provide the data required for the renderer to operate properly.
protected void	validate() Makes sure that WTChangeOrder2 is in proper state for release to ERP.

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

getObjectID

protected String getObjectID()

Gets the value of the attribute: objectID; The UFID of a WTChangeOrder 2.

Supported API: true

Returns:

String

isDelta

protected boolean isDelta()

Gets the value of the attribute: delta; Should RPC responses contain only information that has changed since the last time objects were released?

Supported API: true

Returns:

boolean

isComponentParts

protected boolean isComponentParts()

Gets the value of the attribute: componentParts; When BOMs are exported, should parts be created for BOM components?

Supported API: true

Returns:

boolean

isAlternates

protected boolean isAlternates()

Gets the value of the attribute: alternates; When parts are exported, should the alternates of the parts (if any are defined) be exported?

Supported API: true

Returns:

boolean

isSubstitutes

protected boolean isSubstitutes()

Gets the value of the attribute: substitutes; If "true", returns substitute data.

Supported API: true

Returns:

boolean

isReferenceDesignators

protected boolean isReferenceDesignators()

Gets the value of the attribute: referenceDesignators; If "true", returns Reference Designator data.

Supported API: true

Returns:

boolean

isLineNumbers

protected boolean isLineNumbers()

Gets the value of the attribute: lineNumbers; If "true", returns line numbers info, otherwise no line numbers info is returned.

Supported API: true

Returns:

boolean

getMultiLevel

protected String getMultiLevel()

Gets the value of the attribute: multiLevel; The number of levels of BOM.

Supported API: true

Returns:

String

isDocuments

protected boolean isDocuments()

Gets the value of the attribute: documents; If "true", returns associated documents info, default is "false".

Supported API: true

Returns:

boolean

getConfigSpec

protected String getConfigSpec()

Gets the value of the attribute: configSpec; The Config Spec. value to use when navigating BOMs. See the Query-Tree Webject documentation for acceptable and default values.

Supported API: true

Returns:

String

getAuth

protected String getAuth()

Gets the value of the attribute: auth; Authentication information for Info*Engine tasks.

Supported API: true

Returns:

String

getWcAdapter

protected String getWcAdapter()

Gets the value of the attribute: wcAdapter; The name of the Windchill adapter.

Supported API: true

Returns:

String

getTransactionID

protected String getTransactionID()

Gets the value of the attribute: transactionID; The number of the transaction to associate with the output from renderer.

Supported API: true

Returns:

String

validate

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

Makes sure that WTChangeOrder2 is in proper state for release to ERP.

Supported API: true

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

buildGroups

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

Calls ESIChangeHeaderRenderer to create the ECN header group. Calls ESIChangeEvaluator to determine whether change items are parts or BOMs. Calls ESIWTPartRenderer with the list of parts. Calls BOMRenderer recursively with BOMs.

Supported API: true

Specified by:

buildGroups in class ResponseRendererImpl

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

setData

public void setData(String objectID,
                    boolean delta,
                    boolean componentParts,
                    boolean alternates,
                    boolean substitutes,
                    boolean referenceDesignators,
                    boolean lineNumbers,
                    String mulitLevel,
                    boolean documents,
                    String configSpec,
                    String auth,
                    String wcAdapter,
                    String transactionID)
             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 ChangeOrder2Renderer

Parameters:

objectID - The UFID of a WTChangeOrder 2.

delta - Should RPC responses contain only information that has changed since the last time objects were released?

componentParts - When BOMs are exported, should parts be created for BOM components?

alternates - When parts are exported, should the alternates of the parts (if any are defined) be exported?

substitutes - If "true", returns substitute data.

referenceDesignators - If "true", returns Reference Designator data.

lineNumbers - If "true", returns line numbers info, otherwise no line numbers info is returned.

mulitLevel - The number of levels of BOM.

documents - If "true", returns associated documents info, default is "false". Only operative if "Parts" = "true".

configSpec - The Config Spec. value to use when navigating BOMs. See the Query-Tree Webject documentation for acceptable and default values.

auth - Authentication information for Info*Engine tasks.

wcAdapter - The name of the Windchill adapter.

transactionID - The number of the transaction to associate with the output from renderer.

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException