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

java.lang.Object
  org.eclipse.stardust.engine.api.query.ProcessDefinitionFilter

All Implemented Interfaces:

java.io.Serializable, FilterCriterion

public class ProcessDefinitionFilter
extends java.lang.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(java.lang.String processID)
Creates a filter matching the process definition identified by processID and all of its subprocesses.

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

Method Summary

java.lang.Object	accept(FilterEvaluationVisitor visitor, java.lang.Object context) Visitor dispatch callback used for evaluating filter criteria.
java.lang.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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessDefinitionFilter

public ProcessDefinitionFilter(java.lang.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(java.lang.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 java.lang.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 java.lang.Object accept(FilterEvaluationVisitor visitor,
                               java.lang.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.