Package com.ptc.windchill.esi.treenavigation

Interface TreeNavigationRequestBuilder

All Known Implementing Classes:
BOMTreeNavigationReqBuilder, EPMDocTreeNavigationReqBuilder
public interface TreeNavigationRequestBuilder
A TreeNavigationRequestBuilder interface is an interface used by TreeNavigator to navigate structure information for processing it further to render.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    TreeNavigationRequest
    getNavigationRequests(WTCollection seed)
    Returns the TreeNavigationRequest for the specified input objects, depth and Navigation criteria (i.e.
    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.

  • Method Details

    • getNavigationRequests

      TreeNavigationRequest getNavigationRequests(WTCollection seed)
      Returns the TreeNavigationRequest for the specified input objects, depth and Navigation criteria (i.e. filter) 
       Note:
 Implementation must handle scenario when depth is set to 0 to return appropriate TreeNavigationRequest so that no
 navigation is performed by TreeNavigator; only other association information is found. This is important for
 performance of structure navigation.
 
      
 Example:
      
  Say a root of CAD Document is a structure however user is interested in finding references associated to this object. 
  In such a scenario navigating a structure with depth '0' would add unnecessary overheads. 
  To avoid this return TreeNavigationRequest to find references based on input seed.


      Supported API: true

      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

    • hasNavigationRequest

      boolean hasNavigationRequest()
      Returns true if there exists TreeNavigationRequest object to be processed

      Supported API: true

      Returns:

    • size

      int size()
      Returns size of TreeNavigationRequest object.

      Supported API: true

      Returns:

    • initialize

      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

      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.