com.ptc.windchill.esi.ecn
Class ESIWTChangeOrder2Renderer

java.lang.Object
  com.ptc.windchill.esi.rnd.BasicESIRenderer
      com.ptc.windchill.esi.ecn.ESIWTChangeOrder2Renderer

All Implemented Interfaces:

ESIRenderer, Serializable

public class ESIWTChangeOrder2Renderer
extends BasicESIRenderer
implements Serializable

This class renders the output of ECN, which includes ECN header , part and BOM.

Supported API: true

Extendable: false

See Also:

Serialized Form

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.
com.infoengine.object.IeCollection	getECN(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) getECN RPC processor.
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.
protected void	validate() Makes sure that WTChangeOrder2 is in proper state for release to ERP.

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

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 BasicESIRenderer

Throws:

com.ptc.windchill.esi.rnd.ESIRendererException

getECN

public com.infoengine.object.IeCollection getECN(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 WTException

getECN RPC processor. Obtains a VdbBuilder from the VdbBuilder factory. Invokes the render() method on the renderer. Returns the result of VdbBuilder asVDB().

Supported API: true

Parameters:

objectID - The UFID of a WTChangeOrder2.

delta - If true, return only the objects that have changed since the last release of the changeables on the ECN.

componentParts - if true, invoke getPart for each BOM component.

alternates - If true, return the alternate parts for BOMs, parts and component parts.

substitutes - If "true", returns substitute data

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

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

mulitLevel - The number of levels of BOM, default is 1.

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 - This parameter contains authentication information from I*E.

wcAdapter - This parameter contains the name of the Windchill adapter.

transactionID - The TransactionID for this ObjectID.

Returns:

IeCollection

Throws:

WTException