|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.eclipse.stardust.engine.api.query.Query
org.eclipse.stardust.engine.api.query.WorklistQuery
public class WorklistQuery
Query for retrieving (parts of) a user's worklist.
The retrieved worklist possibly includes contributions from:
setUserContribution(boolean) and
setUserContribution(SubsetPolicy))setParticipantContribution(PerformingParticipantFilter) and
setParticipantContribution(PerformingParticipantFilter, SubsetPolicy))Valid filter criteria, applying to items from all contributing worklists, are:
FilterTerm for building complex criteria.UnaryOperatorFilter, BinaryOperatorFilter or
TernaryOperatorFilter for applying filters to activity instance attributes (see
START_TIME or LAST_MODIFICATION_TIME).ProcessDefinitionFilter for finding instances of activities belonging to
specific process definitions.ProcessInstanceFilter for finding activities belonging to specific process
instances.ActivityFilter for finding instances of specific activities.ActivityStateFilter for finding activity instances currently being in
specific states: APPLICATION or SUSPENDEDDataFilter for finding activity instances belonging to process instances
with same scope process instance containing specific workflow data.SubProcessDataFilter for finding activity instances belonging to process
instances and its subprocess instances containing specific workflow data.HierarchyDataFilter for finding activity instances belonging to the
complete hierarchy of process instances containing specific workflow data.
ActivityInstanceQuery,
Serialized Form| Nested Class Summary | |
|---|---|
static class |
WorklistQuery.Attribute
Worklist item attribute supporting filter operations. |
static class |
WorklistQuery.ParticipantContribution
Class describing participant worklist contributions. |
static class |
WorklistQuery.UserContribution
Class describing the user's private worklist contribution. |
| Field Summary | |
|---|---|
static WorklistQuery.Attribute |
ACTIVITY_INSTANCE_CRITICALITY
The criticality of the activity instance work item. |
static WorklistQuery.Attribute |
ACTIVITY_INSTANCE_OID
The OID of the activity instance the worklist item represents. |
static WorklistQuery.Attribute |
ACTIVITY_OID
The OID of the activity the worklist item is an instance of. |
static WorklistQuery.Attribute |
LAST_MODIFICATION_TIME
The timestamp when the activity instance was last modified. |
static WorklistQuery.Attribute |
PROCESS_INSTANCE_OID
The OID of the process instance the worklist item belongs to. |
static FilterableAttribute |
PROCESS_INSTANCE_PRIORITY
The priority of the process instance the activity instance belongs to. |
static WorklistQuery.Attribute |
START_TIME
The timestamp when the activity instance was created. |
| Constructor Summary | |
|---|---|
WorklistQuery()
Initializes a new WorklistQuery to retrieve the user's private worklist. |
|
| Method Summary | |
|---|---|
Object |
evaluateFilter(FilterEvaluationVisitor visitor,
Object context)
Template method used for query evaluation. |
static WorklistQuery |
findCompleteWorklist()
Creates a query for retrieving all items from the user's private worklist plus all items from role and organization worklists the user belongs to directly or indirectly via the participant hierarchy. |
static WorklistQuery |
findPrivateWorklist()
Prepares a query for retrieving all items from the user's private worklist. |
static WorklistQuery |
findPrivateWorklist(int maxSize)
Creates a query for retrieving up to maxSize items from the user's
private worklist. |
Collection<? extends WorklistQuery.ParticipantContribution> |
getModelParticipantContributions()
|
WorklistQuery.UserContribution |
getUserContribution()
Gets the currently configured contribution of the user's private worklist to the retrieved result. |
Collection<? extends WorklistQuery.ParticipantContribution> |
getUserGroupContributions()
|
void |
setParticipantContribution(PerformingParticipantFilter filter)
Configures the worklist(s) resulting from the given participant filter to be included in the result. |
void |
setParticipantContribution(PerformingParticipantFilter filter,
SubsetPolicy subset)
Configures the worklist(s) resulting from the given participant filter to be included in the result, restricting the size of these worklist according to the given |
void |
setUserContribution(boolean included)
Configures the user's private worklist to be either included or ommitted from the result. |
void |
setUserContribution(SubsetPolicy subset)
Configures the user's private worklist to be partially included in the result. |
| Methods inherited from class org.eclipse.stardust.engine.api.query.Query |
|---|
getFilter, getOrderCriteria, getPolicy, orderBy, orderBy, orderBy, removePolicy, setPolicy, toString, where |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final WorklistQuery.Attribute START_TIME
public static final WorklistQuery.Attribute LAST_MODIFICATION_TIME
public static final WorklistQuery.Attribute ACTIVITY_OID
public static final WorklistQuery.Attribute ACTIVITY_INSTANCE_OID
public static final WorklistQuery.Attribute PROCESS_INSTANCE_OID
public static final WorklistQuery.Attribute ACTIVITY_INSTANCE_CRITICALITY
public static final FilterableAttribute PROCESS_INSTANCE_PRIORITY
ProcessInstanceBean.getPriority()| Constructor Detail |
|---|
public WorklistQuery()
WorklistQuery to retrieve the user's private worklist.
| Method Detail |
|---|
public static WorklistQuery findPrivateWorklist()
findPrivateWorklist(int),
findCompleteWorklist()public static WorklistQuery findPrivateWorklist(int maxSize)
maxSize items from the user's
private worklist.
maxSize - The maximum number of items to retrieve.
findPrivateWorklist(),
findCompleteWorklist()public static WorklistQuery findCompleteWorklist()
findPrivateWorklist(),
PerformingParticipantFilter.ANY_FOR_USERpublic WorklistQuery.UserContribution getUserContribution()
setUserContribution(boolean)public void setUserContribution(boolean included)
The size of the private worklist contribution will be restricted by the
SubsetPolicy set via Query.setPolicy(EvaluationPolicy), if existing.
included - Flag indicating if the user's private worklist will be included in the
result.setUserContribution(SubsetPolicy),
setParticipantContribution(PerformingParticipantFilter)public void setUserContribution(SubsetPolicy subset)
subset - The specification of the subset of the user's private worklist to be
included in the result.setUserContribution(boolean),
setParticipantContribution(PerformingParticipantFilter, SubsetPolicy)public Collection<? extends WorklistQuery.ParticipantContribution> getUserGroupContributions()
public Collection<? extends WorklistQuery.ParticipantContribution> getModelParticipantContributions()
public void setParticipantContribution(PerformingParticipantFilter filter)
The size of all these worklist contributions will be restricted by the
SubsetPolicy set via Query.setPolicy(EvaluationPolicy), if existing.
filter - The filter used to specify the participants contributing their worklists
to the result.
public void setParticipantContribution(PerformingParticipantFilter filter,
SubsetPolicy subset)
subset
.
filter - The filter used to determine the participants contributing their worklists
to the result.subset - The specification of the subset of each participant's worklist to be
included in the result.
public Object evaluateFilter(FilterEvaluationVisitor visitor,
Object context)
QuerygetFilter().accept(visitor, context).
Can be overwritten to manipulate the tree of filter criteria before evaluation.
visitor - The visitor used for filter evaluation.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||