Package com.ptc.windchill.esi.bom

Class BOMTreeNavigationReqBuilder

java.lang.Object

com.ptc.windchill.esi.bom.BOMTreeNavigationReqBuilder

All Implemented Interfaces:

TreeNavigationRequestBuilder

public class BOMTreeNavigationReqBuilder
extends Object
implements TreeNavigationRequestBuilder

TreeNavigationRequest builder for WTPart structure.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
TreeNavigationRequest	getNavigationRequests(WTCollection seed)	Returns the TreeNavigationRequest based on the set of objects passed in the seeds collection.
boolean	hasNavigationRequest()	Returns true if there exists TreeNavigationRequest object to be processed Supported API: true
void	initialize(int depth, NavigationCriteria nco, Map<String,Object> navigationOptions)	Set the depth, NavigationCriteria and other navigation options to be used for building TreeNavigationRequest.
int	size()	Returns size of TreeNavigationRequest object.

Methods inherited from class java.lang.Object

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

Method Details

getNavigationRequests

public TreeNavigationRequest getNavigationRequests(WTCollection seed)

Returns the TreeNavigationRequest based on the set of objects passed in the seeds collection. *

Supported API: true

Specified by:

getNavigationRequests in interface TreeNavigationRequestBuilder

Parameters:

seed - - The collection of seed object. It can contain one or more objects. TreeNavigator will call hasMoreNavigationRequest() method multiple times. This is kind of iterative API called multiple times, if for an object type navigation needs to be done by multiple invocation. When for an object type, multiple request are needed to be processed based on the result of the first execution, TreeNavigator will call this by passing objects found in fist execution.

Returns:

TreeNavigationRequest

See Also:

• TreeNavigationRequestBuilder.getNavigationRequests(wt.fc.collections.WTCollection)

hasNavigationRequest

public boolean hasNavigationRequest()

Returns true if there exists TreeNavigationRequest object to be processed

Supported API: true

Specified by:

hasNavigationRequest in interface TreeNavigationRequestBuilder

Returns:

size

public int size()

Returns size of TreeNavigationRequest object.

Supported API: true

Specified by:

size in interface TreeNavigationRequestBuilder

Returns:

initialize

public void initialize(int depth,
 NavigationCriteria nco,
 Map<String,Object> navigationOptions)

Set the depth, NavigationCriteria and other navigation options to be used for building TreeNavigationRequest.

Supported API: true

Specified by:

initialize in interface TreeNavigationRequestBuilder

Parameters:

depth - - The depth that needs to be used for specified ESITarget and specified persistable while navigating the structure.

nco - - The NavigationCriteria object to be used for specified ESITarget and specified persistable while navigating the structure.

navigationOptions - - The navigations options to be used for specified ESITarget and specified persistable while navigating the structure.
Example: Process reference associations etc.