org.yawlfoundation.yawl.resourcing

Class WorkQueue

java.lang.Object

org.yawlfoundation.yawl.resourcing.WorkQueue

public class WorkQueue
extends java.lang.Object

Convenience class that encapsulates the various work queues for a Participant and/or Administrator - each instance representing a single queue

Author:

Michael Adams v0.1, 03/08/2007

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOCATED
static int	OFFERED
static int	STARTED
static int	SUSPENDED
static int	UNDEFINED
static int	UNOFFERED
static int	WORKLISTED

Constructor Summary

Constructors

Constructor and Description
WorkQueue()
WorkQueue(java.lang.String ownerID, java.util.HashMap<java.lang.String,WorkItemRecord> items, int qType, boolean persisting)
WorkQueue(java.lang.String ownerID, int qType, boolean persisting)
WorkQueue(java.lang.String ownerID, WorkItemRecord item, int qType, boolean persisting)
WorkQueue(java.lang.String ownerID, WorkQueue queue, int qType, boolean persisting)

Method Summary

Modifier and Type	Method and Description
void	add(WorkItemRecord item, boolean log) Adds a workitem to the queue
void	addQueue(java.util.Map<java.lang.String,WorkItemRecord> queueMap) Adds all members of the Map passed to the queue
void	addQueue(WorkQueue queue) Adds all the items in the queue passed to this work queue (i.e.
void	cleanse(WorkItemCache cache)
void	clear()
void	fromXML(Element element)
void	fromXML(java.lang.String xml)
WorkItemRecord	get(java.lang.String itemID) Retrieves a workitem from the queue (but does not remove it)
java.util.Set<WorkItemRecord>	getAll() Retrieves a Set of all workitems in the queue
java.lang.String	getID()
java.lang.String	getOwnerID()
java.util.Map<java.lang.String,WorkItemRecord>	getQueueAsMap() Retrieves a HashMap of all workitems in the queue
java.lang.String	getQueueName() returns the name of this queue
static java.lang.String	getQueueName(int qType) returns the appropriate String identifier for the queue type passed
int	getQueueSize() returns the number of workitems in this queue
int	getQueueType()
boolean	isEmpty()
boolean	isPersisting()
static boolean	isValidQueueType(int queueType)
void	refresh(WorkItemRecord wir)
boolean	remove(WorkItemRecord item) Removes a workitem from the queue
void	removeCase(java.lang.String caseID)
void	removeQueue(WorkQueue queue) Removes all the items in the queue passed from this work queue (i.e.
void	setOwnerID(java.lang.String id)
void	setPersisting(boolean persist)
void	setQueue(WorkQueue queue) Sets (replaces) this work queue's members with the members of the queue passed
void	setQueueType(int qType)
java.lang.String	toXML()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

OFFERED

public static final int OFFERED

See Also:

Constant Field Values

ALLOCATED

public static final int ALLOCATED

See Also:

Constant Field Values

STARTED

public static final int STARTED

See Also:

Constant Field Values

SUSPENDED

public static final int SUSPENDED

See Also:

Constant Field Values

UNOFFERED

public static final int UNOFFERED

See Also:

Constant Field Values

WORKLISTED

public static final int WORKLISTED

See Also:

Constant Field Values

Constructor Detail

WorkQueue

public WorkQueue()

WorkQueue

public WorkQueue(java.lang.String ownerID,
                 int qType,
                 boolean persisting)

WorkQueue

public WorkQueue(java.lang.String ownerID,
                 WorkItemRecord item,
                 int qType,
                 boolean persisting)

WorkQueue

public WorkQueue(java.lang.String ownerID,
                 java.util.HashMap<java.lang.String,WorkItemRecord> items,
                 int qType,
                 boolean persisting)

WorkQueue

public WorkQueue(java.lang.String ownerID,
                 WorkQueue queue,
                 int qType,
                 boolean persisting)

Method Detail

setOwnerID

public void setOwnerID(java.lang.String id)

getOwnerID

public java.lang.String getOwnerID()

getID

public java.lang.String getID()

getQueueType

public int getQueueType()

setQueueType

public void setQueueType(int qType)

isPersisting

public boolean isPersisting()

setPersisting

public void setPersisting(boolean persist)

add

public void add(WorkItemRecord item,
                boolean log)

Adds a workitem to the queue

Parameters:

item - the workitem to add

addQueue

public void addQueue(java.util.Map<java.lang.String,WorkItemRecord> queueMap)

Adds all members of the Map passed to the queue

Parameters:

queueMap - the Map of [item id, YWorkItem] to add

addQueue

public void addQueue(WorkQueue queue)

Adds all the items in the queue passed to this work queue (i.e. does not replace the queue)

Parameters:

queue - the queue of items to add

setQueue

public void setQueue(WorkQueue queue)

Sets (replaces) this work queue's members with the members of the queue passed

Parameters:

queue - the new queue

get

public WorkItemRecord get(java.lang.String itemID)

Retrieves a workitem from the queue (but does not remove it)

Parameters:

itemID - the ID of the workitem to retrieve

Returns:

the retrieved workitem

getAll

public java.util.Set<WorkItemRecord> getAll()

Retrieves a Set of all workitems in the queue

Returns:

a Set of all WorkItemRecord objects in the work queue

getQueueAsMap

public java.util.Map<java.lang.String,WorkItemRecord> getQueueAsMap()

Retrieves a HashMap of all workitems in the queue

Returns:

all members of the queue as a HashMap of [item id, YWorkItem]

remove

public boolean remove(WorkItemRecord item)

Removes a workitem from the queue

Parameters:

item - the workitem to remove

removeQueue

public void removeQueue(WorkQueue queue)

Removes all the items in the queue passed from this work queue (i.e. does not replace the queue)

Parameters:

queue - the queue of items to remove

clear

public void clear()

refresh

public void refresh(WorkItemRecord wir)

cleanse

public void cleanse(WorkItemCache cache)

removeCase

public void removeCase(java.lang.String caseID)

isEmpty

public boolean isEmpty()

Returns:

true if the work queue contains no work items

getQueueSize

public int getQueueSize()

returns the number of workitems in this queue

getQueueName

public static java.lang.String getQueueName(int qType)

returns the appropriate String identifier for the queue type passed

isValidQueueType

public static boolean isValidQueueType(int queueType)

getQueueName

public java.lang.String getQueueName()

returns the name of this queue

toXML

public java.lang.String toXML()

fromXML

public void fromXML(java.lang.String xml)

fromXML

public void fromXML(Element element)