com.ptc.windchill.esi.bom
Interface BOMTreeNavigator

All Known Implementing Classes:

BOMTreeNavigatorImpl

public interface BOMTreeNavigator

Parses the results of a Query-Tree webject.

Supported API: true

Extendable: true

Method Summary

Collection	getBomNodeUfids() Returns a collection part UFIDs for all of the nodes in the tree that are BOMs.
Collection	getLeafNodeUfids() Returns a collection part UFIDs for all of the nodes in the tree that are not BOMs.
void	setData(WTPart root, int depth, String configSpec, String auth, String adapter) Sets the attributes on the object.

Method Detail

getBomNodeUfids

Collection getBomNodeUfids()
                           throws WTException

Returns a collection part UFIDs for all of the nodes in the tree that are BOMs.

Supported API: true

Returns:

Collection

Throws:

WTException

getLeafNodeUfids

Collection getLeafNodeUfids()
                            throws WTException

Returns a collection part UFIDs for all of the nodes in the tree that are not BOMs.

Supported API: true

Returns:

Collection

Throws:

WTException

setData

void setData(WTPart root,
             int depth,
             String configSpec,
             String auth,
             String adapter)
             throws WTException

Sets the attributes on the object.

Supported API: true

Parameters:

root - The assembly part for the top-level BOM.

depth - The number of levels of BOM.

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

auth - This parameter contains authentication information from I*E.

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

Throws:

WTException