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

Class AbstractWorkableFilterDelegate

java.lang.Object
com.ptc.windchill.enterprise.massChange.filters.AbstractDefaultFilterDelegate
com.ptc.windchill.enterprise.massChange.filters.AbstractWorkableFilterDelegate
All Implemented Interfaces:
MassChangeFilterDelegate
Direct Known Subclasses:
AbstractDocumentLinkFilterDelegate, AbstractPartUsageFilterDelegate, com.ptc.windchill.mpml.masschange.filters.AbstractResourceFilterDelegate
public abstract class AbstractWorkableFilterDelegate extends AbstractDefaultFilterDelegate
This class is responsible for processing the selected mass change operation. Also contains common filter logic for excluding logic for objects that are not eligible for the mass change operation. Performs operation that are specific to Workable objects.

Supported API: true

Extendable: true
See Also:

  • Method Details

    • preProcessOperation

      protected void preProcessOperation(MassChangeFilterState mcFilterState) throws WTException
      Check out Workable mass change target objects.
      Overridden methods must have first line: super.preProcessOperation(mcFilterState)

      Supported API: true
      Overrides:
      preProcessOperation in class AbstractDefaultFilterDelegate
      Parameters:
      mcFilterState - MassChangeFilterState object populated with mass change target objects.
      Throws:
      WTException

    • postProcessOperation

      protected void postProcessOperation(MassChangeFilterState mcFilterState) throws WTException
      Check in Workable mass change target objects. Objects that have been excluded during processing will have their check out undone.
      Overridden methods must have last line: super.postProcessOperation(mcFilterState)

      Supported API: true
      Overrides:
      postProcessOperation in class AbstractDefaultFilterDelegate
      Parameters:
      mcFilterState - MassChangeFilterState object populated with mass change target objects.
      Throws:
      WTException

    • getChangeableSourceName

      protected abstract String getChangeableSourceName()
      Get the constant value for the target item of mass change operation
      Returns:
      field name containing the changeable oid.

      Supported API: true

    • preEvaluate

      protected void preEvaluate(MassChangeFilterState mcFilterState) throws WTException
      Filter out mass change target objects for the following conditions:
      1. Target object is checked out by someone other than the current principal.
      2. Target object is checked out to a project.
      3. Target object is not in the specified view.
      Filtered objects will be marked as excluded. All objects be evaluated for the checked out conditions, regardless of whether or not they're already checked out.

      Overridden methods must have first line: super.preEvaluate(mcFilterState)

      Supported API: true

      Overrides:
      preEvaluate in class AbstractDefaultFilterDelegate
      Parameters:
      mcFilterState - MassChangeFilterState object populated with mass change target objects.
      Throws:
      WTException

    • filterCheckout

      protected void filterCheckout(MassChangeFilterState mcFilterState) throws WTException
      Filter out mass change target objects that are checked out by someone other than the current principal or are checked out to a project. Filtered objects will be marked as excluded. Objects already excluded will not be evaluated.

      Supported API: true
      Parameters:
      mcFilterState - MassChangeFilterState object populated with mass change target objects.
      Throws:
      WTException

    • getCheckedOutByMe

      protected WTSet getCheckedOutByMe()
      Get set of mass change target objects checked out by the current principal prior to the mass change operation.

      Supported API: true
      Returns:
      Set of original copies (guaranteed non-null, may be empty, cannot be updated).

    • getTargetWorkingCopies

      protected WTSet getTargetWorkingCopies()
      Get set of mass change target working copies. Will only be populated after preProcessOperation(MassChangeFilterState) is called.

      Supported API: true
      Returns:
      Set of all target working copies (guaranteed non-null, may be empty, cannot be updated).

    • filterView

      protected void filterView(MassChangeFilterState mcFilterState) throws WTException
      Filter out mass change target objects that are not in the specified view. Filtered objects will be marked as excluded. Objects already excluded will not be evaluated.

      Supported API: true
      Parameters:
      mcFilterState - MassChangeFilterState object populated with mass change target objects.
      Throws:
      WTException