|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList
org.eclipse.stardust.engine.api.query.Worklist
public abstract class Worklist
Represents a worklist in it's hierarchical structure.
| Method Summary | |
|---|---|
Object |
get(int index)
|
List |
getCumulatedItems()
Retrieves a cumulated view of items belonging directly and indirectly to this worklist. |
int |
getCumulatedSize()
Retrieves the number of items belonging directly and indirectly to this worklist. |
abstract ParticipantInfo |
getOwner()
Retrieves the owning participant of this worklist. |
abstract String |
getOwnerID()
The human readable ID of the worklist owner. |
abstract String |
getOwnerName()
The name of the owner of the worklist. |
abstract long |
getOwnerOID()
The OID of the owner of this worklist. |
WorklistQuery |
getQuery()
Retrieves the query this worklist is based on. |
SubsetPolicy |
getSubsetPolicy()
Retrieves the subset policy this worklist is based on. |
abstract Iterator |
getSubWorklists()
Retrieves an iterator over all contained sub-worklists. |
long |
getTotalCount()
Gets the optionally evaluated count of all items satisfying the query this result is based on. |
long |
getTotalCountThreshold()
This returns the configured threshold up to which total count is counted exactly. |
boolean |
hasMore()
Indicates if there are more worklist items available (maybe inherited from participant contributions) in either this worklist or any of its participant contributions than allowed by the contribution definition's SubsetPolicy. |
boolean |
hasMorePrivateItems()
Indicates if there are more noninherited items available in this worklist (i.e. |
abstract boolean |
isUserWorklist()
Indicates if the worklist is a user worklist or a participant worklist. |
int |
size()
Retrieves the number of items belonging directly to this worklist. |
| Methods inherited from class java.util.AbstractList |
|---|
add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, set, subList |
| Methods inherited from class java.util.AbstractCollection |
|---|
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.List |
|---|
add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList, toArray, toArray |
| Method Detail |
|---|
public abstract ParticipantInfo getOwner()
public abstract boolean isUserWorklist()
User worklists may contain nested sub-worklists, while participant worklists can't.
true in case of a user worklist, false in case of
a participant worklist.public abstract long getOwnerOID()
If the worklist belongs to a participant not existing anymore in the current
model version the OID will be 0.
getOwnerID()public abstract String getOwnerID()
getOwnerOID()public abstract String getOwnerName()
If the worklist belongs to a participant not existing anymore in the current model version the name will be empty.
getOwnerID()public WorklistQuery getQuery()
WorklistQuery the worklist is based on.public abstract Iterator getSubWorklists()
Only user worklists may contain sub-worklists.
Worklist.isUserWorklist()public Object get(int index)
get in interface Listget in class AbstractListpublic int size()
size in interface Collectionsize in interface Listsize in class AbstractCollectionSubsetPolicy. The size of possibly existing
sub-worklist is not taken into account.getCumulatedSize(),
List.iterator()
public long getTotalCount()
throws UnsupportedOperationException
QueryResultSubsetPolicy.
If no subset policy is used, the total count of items is equal the size of the query
result.
getTotalCount in interface QueryResultUnsupportedOperationException - if the evaluation of the total count was not
requestedSubsetPolicy.isEvaluatingTotalCount()public SubsetPolicy getSubsetPolicy()
getSubsetPolicy in interface QueryResultSubsetPolicy the worklist is based on.public boolean hasMore()
SubsetPolicy.
hasMore in interface QueryResulttrue if there are more items available in this worklist,
false if not.hasMorePrivateItems(),
getSubsetPolicy()public boolean hasMorePrivateItems()
SubsetPolicy.
true if there are more noninherited items available in this
worklist, false if not.getSubsetPolicy()public int getCumulatedSize()
SubsetPolicy. The size of possibly
existing sub-worklist is taken into account.size(),
getCumulatedItems()public List getCumulatedItems()
ActivityInstanceQuery.
SubsetPolicy.getCumulatedSize()public long getTotalCountThreshold()
QueryResult
getTotalCountThreshold in interface QueryResult
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||