Package com.ptc.windchill.baseserver

Interface BasePath

All Superinterfaces:
Serializable
All Known Subinterfaces:
AssociativePath
All Known Implementing Classes:
com.ptc.windchill.associativity.AbstractAssociativePath, com.ptc.windchill.baseserver.AbstractBasePath, PartAssociativePath
public interface BasePath extends Serializable
A run time representation of a path. It follows the PartPathOccurrence model to represent path as recursive model, but stores more information in terms of references to the Part, usage, occurrence (optional). This is used in services around associative structure transformation

Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<Mastered>
    getAllMasteredSet()
    Returns all the masters in the path in no order

    Supported API: true
    List<Persistable>
    getAllPathElements()
    Returns list of persistables from leaf to root in order of associative - occ (optional, only if not null) - usage - associative ...
    Set<Persistable>
    getAllPathElementSet()
    REturns all the elements in the path as a set.
    Workable
    getChild()
    The child of the
    invalid reference 
    usage

    Supported API: true

    String
    getNumberPath(boolean isRootToLeaf)
    Returns part number from root to leaf separated by '|' Example: for associative path [WC000123; usage_link] -> WC000457 it returns WC000457|WC000123

    Supported API: true
    Workable
    getRoot()
    Returns the absolute root in current path
    Supported API: true

    BasePath
    getSubPath()
    Returns the BasePath model containing information about parent child in the structure.
    String
    getUniqueIdPath()
    Returns unique id path from root to leaf.
    UsageLink
    getUsage()
    Returns the UsageLink between the parent and child in the path model
    Supported API: true

  • Method Details

    • getNumberPath

      String getNumberPath(boolean isRootToLeaf)
      Returns part number from root to leaf separated by '|' Example: for associative path [WC000123; usage_link] -> WC000457 it returns WC000457|WC000123

      Supported API: true
      Parameters:
      isRootToLeaf -

    • getAllPathElements

      List<Persistable> getAllPathElements()
      Returns list of persistables from leaf to root in order of associative - occ (optional, only if not null) - usage - associative ...

      Supported API: true
      Returns:
      list of persistables

    • getAllPathElementSet

      Set<Persistable> getAllPathElementSet()
      REturns all the elements in the path as a set. So no order here. Used mainly for performance use cases where lookup within path is needed

      Supported API: true
      Returns:

    • getAllMasteredSet

      Set<Mastered> getAllMasteredSet()
      Returns all the masters in the path in no order

      Supported API: true
      Returns:

    • getChild

      Workable getChild()
      The child of the
      invalid reference 
      usage

      Supported API: true

      Returns:
      the Workable

    • getUsage

      UsageLink getUsage()
      Returns the UsageLink between the parent and child in the path model
      Supported API: true

      Returns:
      the UsageLink

    • getSubPath

      BasePath getSubPath()
      Returns the BasePath model containing information about parent child in the structure. In case the previous child doesn't exist i.e. we have a BasePath model for root then the method returns null.
      Supported API: true

      Returns:
      the sub-path of the current path

    • getRoot

      Workable getRoot()
      Returns the absolute root in current path
      Supported API: true

      Returns:
      the root associative

    • getUniqueIdPath

      String getUniqueIdPath()
      Returns unique id path from root to leaf. It returns occurrence id path for occurrence path and component id path for usage path. In case of mixed path it returns path with occurrence id and component id mix

      Supported API: true
      Returns: