org.eclipse.stardust.engine.api.query

Class UserWorklist

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList

org.eclipse.stardust.engine.api.query.Worklist

org.eclipse.stardust.engine.api.query.UserWorklist

All Implemented Interfaces:

Serializable, Iterable, Collection, List, QueryResult

public class UserWorklist
extends Worklist

Specialization of a Worklist being owned by a User. User worklists usually contain sub-worklists containing work items from granted roles or organizations.

Version:

$Revision$

Author:

rsauer

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
UserInfo	getOwner() Retrieves the owning user of this worklist.
String	getOwnerID() The human readable ID of the worklist owner.
String	getOwnerName() The name of the owner of the worklist.
long	getOwnerOID() The OID of the owner of this worklist.
List	getSubDetails()
Iterator	getSubWorklists() Retrieves an iterator over all contained sub-worklists.
boolean	isUserWorklist() Indicates if the worklist is a user worklist or a participant worklist.

Methods inherited from class org.eclipse.stardust.engine.api.query.Worklist

get, getCumulatedItems, getCumulatedSize, getQuery, getSubsetPolicy, getTotalCount, getTotalCountThreshold, hasMore, hasMorePrivateItems, size

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

getOwner

public UserInfo getOwner()

Retrieves the owning user of this worklist.

Specified by:

getOwner in class Worklist

Returns:

The owning user.

isUserWorklist

public boolean isUserWorklist()

Description copied from class: Worklist

Indicates if the worklist is a user worklist or a participant worklist.

User worklists may contain nested sub-worklists, while participant worklists can't.

Specified by:

isUserWorklist in class Worklist

Returns:

true in case of a user worklist, false in case of a participant worklist.

getOwnerOID

public long getOwnerOID()

Description copied from class: Worklist

The OID of the owner of this worklist.

If the worklist belongs to a participant not existing anymore in the current model version the OID will be 0.

Specified by:

getOwnerOID in class Worklist

Returns:

The owner's OID.

See Also:

Worklist.getOwnerID()

getOwnerID

public String getOwnerID()

Description copied from class: Worklist

The human readable ID of the worklist owner.

Specified by:

getOwnerID in class Worklist

Returns:

The owner's ID.

See Also:

Worklist.getOwnerOID()

getOwnerName

public String getOwnerName()

Description copied from class: Worklist

The name of the owner of the worklist.

If the worklist belongs to a participant not existing anymore in the current model version the name will be empty.

Specified by:

getOwnerName in class Worklist

Returns:

The owner's name.

See Also:

Worklist.getOwnerID()

getSubWorklists

public Iterator getSubWorklists()

Description copied from class: Worklist

Retrieves an iterator over all contained sub-worklists.

Only user worklists may contain sub-worklists.

Specified by:

getSubWorklists in class Worklist

Returns:

An iterator over all conatined sub-worklists. The elements of the iterator are in turn of type Worklist.

See Also:

Worklist.isUserWorklist()

getSubDetails

public List getSubDetails()