Package com.ptc.windchill.enterprise.change2.handler

Interface DispositionHandler

All Known Implementing Classes:
DefaultDispositionHandler
public interface DispositionHandler
Interface for the disposition handler. May be implemented in order to define the classes which support InventoryDisposition as well as any classes which need to be excluded from the base list of supported classes.

Supported API: true

Extendable: true
See Also:

  • Method Details

    • getSupportedClasses

      Set<Class> getSupportedClasses()
      Specifies the set of supported classes which support Inventory Disposition. This set should contain the most generic base type (for example: wt.part.WTPart) that supports the inventory disposition

      Supported API: true
      Returns:
      The set of base type supported classes.

    • getExcludedClasses

      Set<Class> getExcludedClasses()
      Specifies the set of excluded classes which do not support Inventory Disposition. This set is used by the processing of this class to filter out classes which may be supported from the getSupportedClasses( ) list, however a sub-type does not support inventory disposition (such as a com.ptc.windchill.mpml.resource.MPMResource object. This set should be a subset of the supported classes set.

      Supported API: true
      Returns:
      The set of classes that are to be excluded. Should be a subset of the set defined in the getSupportedClasses( ) method.
      See Also:

    • setDispositionValue

      boolean setDispositionValue(String componentId, BinaryLink link, InventoryDisposition disposition) throws WTException
      Sets the inventory disposition value for the given component id for the disposition attribute name on the link.

      Supported API: true
      Parameters:
      componentId - The component id for the disposition attribute name.
      link -
      disposition -
      Returns:
      True if the link is updated with a new disposition attribute value.
      Throws:
      WTException

    • getDispositionValue

      InventoryDisposition getDispositionValue(String componentId, BinaryLink link)
      Returns the inventory disposition value for the given component id and the link.

      Supported API: true
      Parameters:
      componentId - The component id for the disposition attribute name.
      link -
      Returns:
      the inventory disposition value

    • getDefaultInventoryDisposition

      InventoryDisposition getDefaultInventoryDisposition(ChangeLinkAttributeBean linkBean, String component_id)
      Gets the default disposition value to display for the given component id.

      Supported API: true
      Parameters:
      linkBean -
      component_id - The component id for the disposition attribute name.
      Returns:
      the default disposition value to display

    • getInventoryDispositionSet

      ArrayList<InventoryDisposition> getInventoryDispositionSet(ChangeLinkAttributeBean linkBean, String component_id)
      Gets the set of inventory disposition values to display for the given component id.

      Supported API: true
      Parameters:
      linkBean -
      component_id - The component id for the disposition attribute name.
      Returns:
      the set of inventory disposition values to display