Package wt.visitor

Interface Expander

All Superinterfaces:
Enumeration
public interface Expander extends Enumeration
The Expander interface is used for selecting an implementation of the expand operation. In the Windchill architecture, there are several expand implementations. Each expand() method can also take different arguments. An implementation of the Expander interface essentially allows one of these methods to be plugged-in to the overall navigation.

The objects returned via the expand() method are depenedent on the implmentation. Therefore, the expand() method does not return a result set directly. Instead, the Expander interface extends the Enumeration interface to support walking through the result set. The methods getLink() and getNode() are provided to return link and node objects for the current element in the enumeration. The Enumeration is implicitly reset when the expand() operation is executed.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    expand(Persistable obj, String role, Object roleObject)
    Expands the object given the role and role object.
    Link
    getLink()
    Returns the Link for the current element in the enumeration.
    Persistable
    getNode()
    Returns the Node for the current element in the enumeration.
    boolean
    hasMoreElements()
    Tests if this enumeration contains more elements.
    Object
    nextElement()
    Returns the next element of this enumeration.

    Methods inherited from interface java.util.Enumeration

    asIterator

  • Method Details

    • expand

      void expand(Persistable obj, String role, Object roleObject) throws WTException
      Expands the object given the role and role object. This Enumeration is reset.

      Supported API: true
      Parameters:
      obj -
      role -
      roleObject -
      Throws:
      WTException

    • getLink

      Link getLink()
      Returns the Link for the current element in the enumeration.

      Supported API: true
      Returns:
      Link

    • getNode

      Persistable getNode()
      Returns the Node for the current element in the enumeration.

      Supported API: true
      Returns:
      Persistable

    • hasMoreElements

      boolean hasMoreElements()
      Tests if this enumeration contains more elements.

      This is only modeled here becuase code-generation does not handle methods from non-Windchill interfaces.

      Supported API: true

      Specified by:
      hasMoreElements in interface Enumeration
      Returns:
      boolean

    • nextElement

      Object nextElement()
      Returns the next element of this enumeration.

      This is only modeled here becuase code-generation does not handle methods from non-Windchill interfaces.

      Supported API: true

      Specified by:
      nextElement in interface Enumeration
      Returns:
      Object