Package wt.ixb.objectset

Interface ObjectSetGenerator

All Superinterfaces:
ObjectSetHandler
All Known Implementing Classes:
wt.ixb.objectset.handlers.navigator.GeneralNavigator, ObjectSetGeneratorTemplate, WTTypeDefinitionNavigator
public interface ObjectSetGenerator extends ObjectSetHandler
This interface is the base for all object set generators. They will be used to compute the product structure for the given object. See the server registry for details.

Supported API: true

Extendable: false

  • Method Details

    • iterate

      void iterate(ObjectVisitor visitor) throws WTException
      Iterate the product structure for export.

      Supported API: true
      Parameters:
      visitor -
      Throws:
      WTException

    • iterate

      Enumeration iterate() throws WTException
      Iterate the product structure for export.

      Supported API: true
      Returns:
      Enumeration
      Throws:
      WTException

    • iteratePerPage

      boolean iteratePerPage(ObjectVisitor visitor, int pageSize) throws WTException
      Iterate the product structure for export. If the number of objects iterated reaches the limit pageSize, do nothing and return.
      This method returns true if the number of objects iterated is less than or equal to pageSize and does not need to iterate furthmore.

      Supported API: true
      Parameters:
      visitor -
      pageSize -
      Returns:
      boolean
      Throws:
      WTException

    • setContainerRef

      void setContainerRef(WTContainerRef containerRef)
      A convenient method to set the WTContainerRef context where the export is launched.

      Supported API: true
      Parameters:
      containerRef -

    • getContainerRef

      WTContainerRef getContainerRef()
      A convenient method to get the WTContainerRef context where the export is launched.

      Supported API: true
      Returns:
      WTContainerRef

    • setConfigSpec

      void setConfigSpec(ConfigSpec configSpec)
      Set ConfigSpec for this object set generator. This is useful for some cases, especially when the ConfigSpec is not persisted and passed from client directly. Individual implementations of this interface are recommended to implement this method to satisfy their needs.

      Supported API: true
      Parameters:
      configSpec -