Package com.ptc.windchill.enterprise.massChange.filters

Class MassChangeFilterState

java.lang.Object
com.ptc.windchill.enterprise.massChange.filters.MassChangeFilterState
public final class MassChangeFilterState extends Object
Aggregates filter status information for all mass change objects.

Supported API: true

Extendable: false

  • Field Details

    • KEY_MASK

      public static final int KEY_MASK
      Key mask used for mass change WTCollection and WTKeyedMap objects.

      Supported API: true
      See Also:

  • Constructor Details

    • MassChangeFilterState

      public MassChangeFilterState(String operation)
      Construct a MassChangeFilterState object.
      Parameters:
      operation -

      Supported API: true

    • MassChangeFilterState

      public MassChangeFilterState(String operation, Collection targets)
      Construct a populated MassChangeFilterState object. All targets are assigned a default filter state.

      Supported API: true
      Parameters:
      operation - Mass change operation name.
      targets - Collection of initial mass change target objects.

    • MassChangeFilterState

      public MassChangeFilterState(NmCommandBean commandBean) throws WTException
      Construct a populated MassChangeFilterState object.

      Supported API: true
      Parameters:
      commandBean - NmCommandBean containing mass change action and selected target objects.
      Throws:
      WTException

  • Method Details

    • getOperation

      public String getOperation()
      Return the mass change operation name.

      Supported API: true

    • isEvaluated

      public boolean isEvaluated()
      Return true if targets have been filter evaluated.

      Supported API: true

    • getTargets

      public WTSet getTargets()
      Get all mass change target objects.

      Supported API: true
      Returns:
      WTSet of target objects references.

    • getTargets

      public WTSet getTargets(Class<?> targetType)
      Get mass change target objects of specified type.

      Supported API: true
      Parameters:
      targetType - Type of mass change objects to return or null to return all types.
      Returns:
      WTSet of target objects references.

    • getTargets

      public WTSet getTargets(Boolean returnExcluded)
      Get included or excluded mass change targets (but not both).

      Supported API: true
      Parameters:
      returnExcluded - True to return excluded target objects, false to return included target objects or null to return both.
      Returns:
      WTSet of target objects references.

    • getTargets

      public WTSet getTargets(Class<?> targetType, Boolean returnExcluded)
      Get included or excluded mass change targets (but not both) of specified type.

      Supported API: true
      Parameters:
      targetType - Type of mass change objects to return or null to return all types.
      returnExcluded - True to return excluded target objects, false to return included target objects or null to return both.
      Returns:
      WTSet of target objects references.

    • addTarget

      public TargetFilterState addTarget(Object target)
      Add a target object. Target is assigned a default filter state.

      Supported API: true
      Parameters:
      target - Mass change target object to be added. Must be non-null WTReference, QueryKey or Persistable object.
      Returns:
      Default TargetFilterState object created for the specified target.

    • removeTarget

      public TargetFilterState removeTarget(Object target)
      Remove a target object.

      Supported API: true
      Parameters:
      target - Mass change target object to be removed. Must be non-null WTReference, QueryKey or Persistable object.
      Returns:
      TargetFilterState object assigned to the specified target, or null if the specified target is not a mass change object.

    • addTargets

      public void addTargets(Collection targets)
      Add collection of target objects. All targets are assigned a default filter state.

      Supported API: true
      Parameters:
      targets - Collection of mass change target objects to be added.

    • removeTargets

      public void removeTargets(Collection targets)
      Remove collection of target objects.

      Supported API: true
      Parameters:
      targets - Collection of mass change target objects to be removed.

    • refreshTargets

      public void refreshTargets() throws WTException
      Refresh all mass change target objects.

      Supported API: true
      Throws:
      WTException

    • getFilterState

      public TargetFilterState getFilterState(Object target)
      Get the filter state of a mass change target object.

      Supported API: true
      Parameters:
      target - Mass change target object to be removed. Must be non-null WTReference, QueryKey or Persistable object.
      Returns:
      TargetFilterState object assigned to the specified target, or null if the specified target is not a mass change object.