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

Class TargetFilterState

java.lang.Object
com.ptc.windchill.enterprise.massChange.filters.TargetFilterState
public final class TargetFilterState extends Object
Aggregates filter status information for a single mass change object.

Supported API: true

Extendable: false

  • Constructor Details

    • TargetFilterState

      public TargetFilterState(Object target)
      Construct a TargetFilterState object with no exclusions.

      Supported API: true
      Parameters:
      target - Mass change target object. Must be non-null WTReference, QueryKey or Persistable object.

  • Method Details

    • getTargetRef

      public WTReference getTargetRef()
      Get reference to target object.

      Supported API: true

    • isFilterExcluded

      public boolean isFilterExcluded()
      Return true if the mass change target object is filter excluded.

      Supported API: true

    • getFilterExclude

      public FilterExclusionType getFilterExclude()
      Get filter exclusion type (null if mass change target not excluded by a filter).

      Supported API: true

    • setFilterExclude

      public void setFilterExclude(FilterExclusionType filterExclude)
      Set filter exclusion type.

      Supported API: true
      Parameters:
      filterExclude - New exclusion type (null if mass change target not excluded by a filter). Cannot be set to FilterExclusionType.MANUAL.

    • clearFilterExclude

      public void clearFilterExclude()
      Clear filter exclusion.

      Supported API: true

    • isManualExcluded

      public boolean isManualExcluded()
      Return true if the mass change target object is manual excluded.

      Supported API: true

    • setManualExclude

      public void setManualExclude(boolean manualExclude)
      Set manual exclude.

      Supported API: true
      Parameters:
      manualExclude - True if mass change target object is manually excluded.

    • isExcluded

      public boolean isExcluded()
      Return true if the mass change target object is excluded by any means.

      Supported API: true

    • isPriorCheckOut

      public boolean isPriorCheckOut()
      Return true if the mass change target object was checked out by the current principal prior to the mass change operation.

      Supported API: true

    • setPriorCheckOut

      public void setPriorCheckOut(boolean priorCheckOut)
      Set prior check out value.

      Supported API: true
      Parameters:
      priorCheckOut - True if the mass change target object was checked out by the current principal prior to the mass change operation.

    • getDisplayValue

      public String getDisplayValue(Locale locale)
      Get localized display value for current filter state. Returns null if mass change target object is not excluded.

      Supported API: true

    • getLongDescription

      public String getLongDescription(Locale locale)
      Get localized long description for current filter state. Returns null if mass change target object is not excluded.

      Supported API: true