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

Class AddDocumentLinkFilterDelegate

java.lang.Object
com.ptc.windchill.enterprise.massChange.filters.AbstractDefaultFilterDelegate
com.ptc.windchill.enterprise.massChange.filters.AbstractWorkableFilterDelegate
com.ptc.windchill.enterprise.massChange.filters.AbstractDocumentLinkFilterDelegate
com.ptc.windchill.enterprise.massChange.filters.AddDocumentLinkFilterDelegate
All Implemented Interfaces:
MassChangeFilterDelegate
public class AddDocumentLinkFilterDelegate extends AbstractDocumentLinkFilterDelegate
This filter delegate determines whether the selected objects are eligible for the mass change operation for the selected document. The AssociationDelegate registered for the selected association type ("Referenced By", "Described By", or "Passive") which is used to filter or create the appropriate association links for the selected objects and the selected document. The supported document types are wt.doc.WTDocument and wt.epm.EPMDocument.

If this delegate is extended or replaced with a customized delegate, the action for the mass change operation should be overridden in a customized actions.xml. The customized delegate should be registered as the command class in the overridden mass change operation action.
This operation is registered with the action name addDocumentUsage

Extendable: true

Supported API: true

See Also:

  • Method Details

    • preProcessOperation

      protected void preProcessOperation(MassChangeFilterState mcFilterState) throws WTException
      Create new associations between target objects and the specified document.
      Overridden methods must have first line: super.preProcessOperation(mcFilterState)

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

    • getHintText

      public String getHintText()
      Retrieve the hint text for the Add Document functionality.

      Supported API: true
      Specified by:
      getHintText in interface MassChangeFilterDelegate
      Overrides:
      getHintText in class AbstractDefaultFilterDelegate
      Returns:
      String - the hint text for the add document usage.

    • preEvaluate

      protected void preEvaluate(MassChangeFilterState mcFilterState) throws WTException
      Filter out mass change target parts that:
      1. Already related to the specified document.
      2. Violate an association constraint with the document.
      Filtered objects will be marked as excluded. Objects already excluded will not be evaluated.

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

      Supported API: true

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

    • filterAlreadyRelated

      protected void filterAlreadyRelated(MassChangeFilterState mcFilterState) throws WTException
      Filter out mass change target parts that are already related to the specified document. 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