com.ptc.windchill.esi.bom
Interface BOMRenderer

All Superinterfaces:

ResponseRenderer

All Known Implementing Classes:

BOMRendererImpl

public interface BOMRenderer

extends ResponseRenderer

Standard interface for all BOM renderers.

Supported API: true

Extendable: true

Method Summary

void

setData(String obid, boolean provideDelta, boolean buildBOMPart, boolean buildComponentParts, boolean buildAlternates, boolean buildSubs, boolean buildRefDes, boolean useLineNumbers, String multiLevel, boolean buildDocs, String configSpec, String auth, String wcAdapter, String transactionID) Initialize the BOM renderer to a ready-to-run state.

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

render

Method Detail

setData

public void setData(String obid,
                    boolean provideDelta,
                    boolean buildBOMPart,
                    boolean buildComponentParts,
                    boolean buildAlternates,
                    boolean buildSubs,
                    boolean buildRefDes,
                    boolean useLineNumbers,
                    String multiLevel,
                    boolean buildDocs,
                    String configSpec,
                    String auth,
                    String wcAdapter,
                    String transactionID)
             throws WTException

Initialize the BOM renderer to a ready-to-run state.

Supported API: true

Parameters:

obid - The UFID of the Assembly part.

provideDelta - Return only those items that have changed since the last release attempt?

buildBOMPart - Should a part be created for the BOM?

buildComponentParts - Should parts be created for the BOM's components?

buildAlternates - When parts are requested, should their alternates also be published?

buildSubs - Are substitutes to be included in the response?

buildRefDes - Are reference designators to be included in the response?

useLineNumbers - Are line numbers supported?

multiLevel - Number of levels to support.

buildDocs - Are documents to be exported when parts are exported?

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

auth - I*E authentication.

wcAdapter - The name of the local Windchill Adapter.

transactionID - The transaction number associated with this RPC request.

Throws:

WTException