|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.query.ActivityFilter
public class ActivityFilter
Restricts the resulting items to the ones related to a specific activity. The search can be further restricted to certain models by passing in a collection of model oids.
| Constructor Summary | |
|---|---|
ActivityFilter(String activityID)
Deprecated. Use forAnyProcess(String) instead. |
|
| Method Summary | |
|---|---|
Object |
accept(FilterEvaluationVisitor visitor,
Object context)
Visitor dispatch callback used for evaluating filter criteria. |
static ActivityFilter |
forAnyProcess(String activityID)
Creates a filter matching the activity identified by activityID. |
static ActivityFilter |
forAnyProcess(String activityID,
Collection modelOids)
Creates a filter matching the activity identified by activityID
and present in the given models modelOids. |
static FilterCriterion |
forProcess(String activityID,
String processID)
Creates a filter matching the activity identified by activityID
within scope of process definition identified by processID. |
static FilterCriterion |
forProcess(String activityID,
String processID,
boolean includingSubProcesses)
Creates a filter matching the activity identified by activityID
within scope of process definition identified by processID. |
static FilterCriterion |
forProcess(String activityID,
String processID,
Collection modelOids,
boolean includingSubProcesses)
Creates a filter matching the activity identified by activityID
within scope of process definition identified by processID. |
String |
getActivityID()
The ID of the activity to filter for. |
Collection |
getModelOids()
Gets the model oids to which the search is restricted to. |
String |
getProcessID()
The ID of the process definition to filter for. |
boolean |
isIncludingSubProcesses()
State whether this filter will be applied to subprocesses as well. |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ActivityFilter(String activityID)
forAnyProcess(String) instead.
activityID.
activityID - The ID of the activity to filter for.| Method Detail |
|---|
public static ActivityFilter forAnyProcess(String activityID)
activityID.
activityID - The ID of the activity to filter for.
public static ActivityFilter forAnyProcess(String activityID,
Collection modelOids)
activityID
and present in the given models modelOids.
activityID - The ID of the activity to filter for.modelOids - The IDs of the models to restrict the search to.
public static FilterCriterion forProcess(String activityID,
String processID)
activityID
within scope of process definition identified by processID.
The created filter will include subprocesses.
activityID - The ID of the activity to filter for. When processID
is set to null then activities are filtered for the whole model,
otherwise for the given process definition.processID - The ID of the process definition to filter for. Can be null.forProcess(String, String, Collection, boolean)
public static FilterCriterion forProcess(String activityID,
String processID,
boolean includingSubProcesses)
activityID
within scope of process definition identified by processID.
activityID - The ID of the activity to filter for. When processID
is set to null then activities are filtered for the whole model,
otherwise for the given process definition.processID - The ID of the process definition to filter for. Can be null.includingSubProcesses - Flag indicating if subprocesses should be included.
public static FilterCriterion forProcess(String activityID,
String processID,
Collection modelOids,
boolean includingSubProcesses)
activityID
within scope of process definition identified by processID.
activityID - The ID of the activity to filter for. When processID
is set to null then activities are filtered for the whole model,
otherwise for the given process definition.processID - The ID of the process definition to filter for. Can be null.includingSubProcesses - Flag indicating if subprocesses should be included.public String getActivityID()
public String getProcessID()
public boolean isIncludingSubProcesses()
true when subprocesses shall be filtered as well, otherwise false.
public Object accept(FilterEvaluationVisitor visitor,
Object context)
return visitor.visit(this, context), thus calling the appropriately
overloaded visitation method.
accept in interface FilterCriterionvisitor - The visitor performing the evaluation.context - Information used by the visitor during the visitation process.
public Collection getModelOids()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||