org.eclipse.stardust.engine.api.query

Class ProcessInstanceFilter

java.lang.Object

org.eclipse.stardust.engine.api.query.ProcessInstanceFilter

All Implemented Interfaces:

Serializable, FilterCriterion

public final class ProcessInstanceFilter
extends Object
implements FilterCriterion

Filter criterion for matching specific process instances.

Version:

$Revision$

Author:

rsauer

See Also:

ProcessInstanceQuery.OID, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessInstanceFilter(long processInstanceOID) Creates a filter matching the closure of the process instance identified by processInstanceOID.
ProcessInstanceFilter(long processInstanceOID, boolean includeSubprocesses) Creates a filter matching either the closure of the process instance identified by processInstanceOID or just the process instance itself.

Method Summary

Methods

Modifier and Type	Method and Description
Object	accept(FilterEvaluationVisitor visitor, Object context) Visitor dispatch callback used for evaluating filter criteria.
long	getOID() Returns the OID of the process instance this filter is based on.
Set	getOids()
static ProcessInstanceFilter	in(Set<Long> oids)
static ProcessInstanceFilter	in(Set<Long> oids, boolean includingSubprocesses)
boolean	isIncludingSubprocesses() Flag indicating if the filter is matching the instance closure (including all subprocess instances) or just the process instance itself.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessInstanceFilter

public ProcessInstanceFilter(long processInstanceOID)

Creates a filter matching the closure of the process instance identified by processInstanceOID.

Parameters:

processInstanceOID - The OID of the process instance to be matched.

See Also:

ProcessInstanceFilter(long, boolean), ProcessInstanceQuery.OID

ProcessInstanceFilter

public ProcessInstanceFilter(long processInstanceOID,
                     boolean includeSubprocesses)

Creates a filter matching either the closure of the process instance identified by processInstanceOID or just the process instance itself.

Parameters:

processInstanceOID - The OID of the process instance to be matched.

includeSubprocesses - Flag indicating if the instance closure (including all subprocess instances) will be used for matching or not.

See Also:

ProcessInstanceFilter(long), ProcessInstanceQuery.OID

Method Detail

getOID

public long getOID()

Returns the OID of the process instance this filter is based on.

Returns:

The OID of the filter's process instance.

See Also:

isIncludingSubprocesses()

getOids

public Set getOids()

isIncludingSubprocesses

public boolean isIncludingSubprocesses()

Flag indicating if the filter is matching the instance closure (including all subprocess instances) or just the process instance itself.

Returns:

true if the filter is matching the instance closure (including all subprocess instances), false if just the process instance itself.

See Also:

getOID()

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.

in

public static ProcessInstanceFilter in(Set<Long> oids)

in

public static ProcessInstanceFilter in(Set<Long> oids,
                       boolean includingSubprocesses)

toString

public String toString()

Overrides:

toString in class Object