org.eclipse.stardust.engine.api.query
Class ProcessDefinitionFilter

java.lang.Object
  extended by org.eclipse.stardust.engine.api.query.ProcessDefinitionFilter
All Implemented Interfaces:
Serializable, FilterCriterion

public class ProcessDefinitionFilter
extends Object
implements FilterCriterion

Restricts the resulting items to the ones related to a specific process definition.

Version:
$Revision$
Author:
rsauer
See Also:
Serialized Form

Constructor Summary
ProcessDefinitionFilter(String processID)
          Creates a filter matching the process definition identified by processID and all of its subprocesses.
ProcessDefinitionFilter(String processID, boolean includingSubprocesses)
          Creates a filter matching the process definition identified by processID.
 
Method Summary
 Object accept(FilterEvaluationVisitor visitor, Object context)
          Visitor dispatch callback used for evaluating filter criteria.
 String getProcessID()
          Gets the ID of the process definition to filter for.
 boolean isIncludingSubProcesses()
          Retrieves the flag indicating if subprocesses should be included or not.
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ProcessDefinitionFilter

public ProcessDefinitionFilter(String processID)
Creates a filter matching the process definition identified by processID and all of its subprocesses.

Parameters:
processID - The ID of the process definition to filter for.
See Also:
ProcessDefinitionFilter(String, boolean)

ProcessDefinitionFilter

public ProcessDefinitionFilter(String processID,
                               boolean includingSubprocesses)
Creates a filter matching the process definition identified by processID.

Parameters:
processID - The ID of the process definition to filter for.
includingSubprocesses - Flag indicating if subprocesses should be included.
See Also:
ProcessDefinitionFilter(String)
Method Detail

getProcessID

public String getProcessID()
Gets the ID of the process definition to filter for.

Returns:
The process definition ID.

isIncludingSubProcesses

public boolean isIncludingSubProcesses()
Retrieves the flag indicating if subprocesses should be included or not.

Returns:
true if subprocesses should be included, false if not.

accept

public Object accept(FilterEvaluationVisitor visitor,
                     Object context)
Description copied from interface: FilterCriterion
Visitor dispatch callback used for evaluating filter criteria. Usually implemented as return visitor.visit(this, context), thus calling the appropriately overloaded visitation method.

Specified by:
accept in interface FilterCriterion
Parameters:
visitor - The visitor performing the evaluation.
context - Information used by the visitor during the visitation process.
Returns:
Visitor specific result of the visitation.

toString

public String toString()
Overrides:
toString in class Object


Copyright © 2017 Eclipse Stardust. All Rights Reserved.