org.yawlfoundation.yawl.engine

Class YWorkItem

java.lang.Object

org.yawlfoundation.yawl.engine.YWorkItem

public class YWorkItem
extends java.lang.Object

Author:

Lachlan Aldred Date: 28/05/2003 Time: 15:29:33 Refactored for v2.0 by Michael Adams 10/2007 - 12/2009

Constructor Summary

Constructors

Constructor and Description
YWorkItem()
YWorkItem(YPersistenceManager pmgr, YSpecificationID specID, YTask task, YWorkItemID workItemID, boolean allowsDynamicCreation, boolean isDeadlocked) Creates an enabled WorkItem

Method Summary

Modifier and Type	Method and Description
void	add_child(YWorkItem child)
void	add_children(java.util.Set children)
void	addToRepository()
boolean	allowsDynamicCreation()
void	cancel(YPersistenceManager pmgr) removes workitems from persistence when cancelled
void	cancelTimer()
void	checkStartTimer(YPersistenceManager pmgr, YNetData data)
void	completeData(Document output) write output data values to event log
YWorkItem	createChild(YPersistenceManager pmgr, YIdentifier childCaseID)
boolean	equals(java.lang.Object other)
boolean	get_allowsDynamicCreation()
java.util.Set	get_children()
java.lang.String	get_dataString()
java.lang.String	get_deferredChoiceGroupID()
java.util.Date	get_enablementTime()
java.lang.String	get_externalClient()
java.util.Date	get_firingTime()
YWorkItem	get_parent()
java.lang.String	get_prevStatus()
java.lang.String	get_specIdentifier()
java.lang.String	get_specUri()
java.lang.String	get_specVersion()
java.util.Date	get_startTime()
java.lang.String	get_status()
java.lang.String	get_thisID()
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
YIdentifier	getCaseID()
java.util.Set<YWorkItem>	getChildren()
java.lang.String	getCodelet()
java.net.URL	getCustomFormURL()
Element	getDataElement()
java.lang.String	getDataString()
java.lang.String	getDeferredChoiceGroupID()
java.lang.String	getDocumentation()
java.util.Date	getEnablementTime()
java.lang.String	getEnablementTimeStr()
YClient	getExternalClient()
java.util.Date	getFiringTime()
java.lang.String	getFiringTimeStr()
java.lang.String	getIDString()
YNetRunner	getNetRunner()
YWorkItem	getParent()
YSpecificationID	getSpecificationID()
java.lang.String	getSpecName()
java.util.Date	getStartTime()
java.lang.String	getStartTimeStr()
YWorkItemStatus	getStatus()
YTask	getTask()
java.lang.String	getTaskID()
long	getTimerExpiry()
YTimerParameters	getTimerParameters()
java.lang.String	getTimerStatus()
YWorkItemID	getWorkItemID()
boolean	hasChildren()
boolean	hasCompletedStatus()
boolean	hasFinishedStatus()
int	hashCode()
boolean	hasLiveStatus()
boolean	hasTimerStarted()
boolean	hasUnfinishedStatus()
boolean	isEnabledSuspended()
boolean	isParent()
boolean	requiresManualResourcing()
void	restoreDataToNet(java.util.Set<YAWLServiceReference> services)
void	rollBackStatus(YPersistenceManager pmgr)
void	set_allowsDynamicCreation(boolean a)
void	set_dataString(java.lang.String s)
void	set_deferredChoiceGroupID(java.lang.String id)
void	set_enablementTime(java.util.Date eTime)
void	set_externalClient(java.lang.String owner)
void	set_firingTime(java.util.Date fTime)
void	set_parent(YWorkItem parent)
void	set_prevStatus(java.lang.String status)
void	set_specIdentifier(java.lang.String id)
void	set_specUri(java.lang.String uri)
void	set_specVersion(java.lang.String version)
void	set_startTime(java.util.Date sTime)
void	set_status(java.lang.String status)
void	set_thisID(java.lang.String thisID)
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
protected void	setChildren(java.util.Set<YWorkItem> children)
void	setCodelet(java.lang.String codelet)
void	setCustomFormURL(java.net.URL formURL)
void	setData(YPersistenceManager pmgr, Element data) write data input values to event log
void	setDeferredChoiceGroupID(java.lang.String id)
void	setExternalLogPredicate(java.lang.String predicate)
void	setInitData(Element data)
void	setRequiresManualResourcing(boolean requires)
void	setStatus(YWorkItemStatus status)
void	setStatusToComplete(YPersistenceManager pmgr, WorkItemCompletion completionFlag)
void	setStatusToDeleted(YPersistenceManager pmgr)
void	setStatusToDiscarded() announces and logs that this workitem has been discarded - ie.
void	setStatusToStarted(YPersistenceManager pmgr, YClient client)
void	setStatusToSuspended(YPersistenceManager pmgr)
void	setStatusToUnsuspended(YPersistenceManager pmgr)
void	setTask(YTask task)
void	setTimerExpiry(long time)
void	setTimerParameters(YTimerParameters params)
void	setTimerStarted(boolean started)
void	setWorkItemID(YWorkItemID workitemid)
java.lang.String	toString()
java.lang.String	toXML()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

YWorkItem

public YWorkItem()

YWorkItem

public YWorkItem(YPersistenceManager pmgr,
                 YSpecificationID specID,
                 YTask task,
                 YWorkItemID workItemID,
                 boolean allowsDynamicCreation,
                 boolean isDeadlocked)
          throws YPersistenceException

Creates an enabled WorkItem

Throws:

YPersistenceException

Method Detail

addToRepository

public void addToRepository()

createChild

public YWorkItem createChild(YPersistenceManager pmgr,
                             YIdentifier childCaseID)
                      throws YPersistenceException

Throws:

YPersistenceException

setExternalLogPredicate

public void setExternalLogPredicate(java.lang.String predicate)

setData

public void setData(YPersistenceManager pmgr,
                    Element data)
             throws YPersistenceException

write data input values to event log

Throws:

YPersistenceException

completeData

public void completeData(Document output)

write output data values to event log

restoreDataToNet

public void restoreDataToNet(java.util.Set<YAWLServiceReference> services)
                      throws YPersistenceException

Throws:

YPersistenceException

cancel

public void cancel(YPersistenceManager pmgr)
            throws YPersistenceException

removes workitems from persistence when cancelled

Throws:

YPersistenceException

checkStartTimer

public void checkStartTimer(YPersistenceManager pmgr,
                            YNetData data)
                     throws YPersistenceException

Throws:

YPersistenceException

cancelTimer

public void cancelTimer()

hasLiveStatus

public boolean hasLiveStatus()

Returns:

true if workitem is 'live'

hasFinishedStatus

public boolean hasFinishedStatus()

Returns:

true if workitem is finished

hasCompletedStatus

public boolean hasCompletedStatus()

Returns:

true if workitem has completed

isParent

public boolean isParent()

hasUnfinishedStatus

public boolean hasUnfinishedStatus()

Returns:

true if workitem is not finished

isEnabledSuspended

public boolean isEnabledSuspended()

Returns:

true if workitem is suspended from enabled status

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setStatusToStarted

public void setStatusToStarted(YPersistenceManager pmgr,
                               YClient client)
                        throws YPersistenceException

Throws:

YPersistenceException

setStatusToComplete

public void setStatusToComplete(YPersistenceManager pmgr,
                                WorkItemCompletion completionFlag)
                         throws YPersistenceException

Throws:

YPersistenceException

setStatusToDeleted

public void setStatusToDeleted(YPersistenceManager pmgr)
                        throws YPersistenceException

Throws:

YPersistenceException

setStatusToDiscarded

public void setStatusToDiscarded()

announces and logs that this workitem has been discarded - ie. left in the net when the net completed

rollBackStatus

public void rollBackStatus(YPersistenceManager pmgr)
                    throws YPersistenceException

Throws:

YPersistenceException

setStatusToSuspended

public void setStatusToSuspended(YPersistenceManager pmgr)
                          throws YPersistenceException

Throws:

YPersistenceException

setStatusToUnsuspended

public void setStatusToUnsuspended(YPersistenceManager pmgr)
                            throws YPersistenceException

Throws:

YPersistenceException

set_parent

public void set_parent(YWorkItem parent)

get_parent

public YWorkItem get_parent()

get_children

public java.util.Set get_children()

hasChildren

public boolean hasChildren()

add_child

public void add_child(YWorkItem child)

add_children

public void add_children(java.util.Set children)

setChildren

protected void setChildren(java.util.Set<YWorkItem> children)

setWorkItemID

public void setWorkItemID(YWorkItemID workitemid)

get_thisID

public java.lang.String get_thisID()

set_thisID

public void set_thisID(java.lang.String thisID)

get_specIdentifier

public java.lang.String get_specIdentifier()

get_specVersion

public java.lang.String get_specVersion()

get_specUri

public java.lang.String get_specUri()

set_specIdentifier

public void set_specIdentifier(java.lang.String id)

set_specUri

public void set_specUri(java.lang.String uri)

set_specVersion

public void set_specVersion(java.lang.String version)

getAttributes

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

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

requiresManualResourcing

public boolean requiresManualResourcing()

setRequiresManualResourcing

public void setRequiresManualResourcing(boolean requires)

getCodelet

public java.lang.String getCodelet()

setCodelet

public void setCodelet(java.lang.String codelet)

getCustomFormURL

public java.net.URL getCustomFormURL()

setCustomFormURL

public void setCustomFormURL(java.net.URL formURL)

get_deferredChoiceGroupID

public java.lang.String get_deferredChoiceGroupID()

set_deferredChoiceGroupID

public void set_deferredChoiceGroupID(java.lang.String id)

get_enablementTime

public java.util.Date get_enablementTime()

set_enablementTime

public void set_enablementTime(java.util.Date eTime)

get_firingTime

public java.util.Date get_firingTime()

set_firingTime

public void set_firingTime(java.util.Date fTime)

get_startTime

public java.util.Date get_startTime()

set_startTime

public void set_startTime(java.util.Date sTime)

get_status

public java.lang.String get_status()

set_status

public void set_status(java.lang.String status)

get_prevStatus

public java.lang.String get_prevStatus()

set_prevStatus

public void set_prevStatus(java.lang.String status)

get_externalClient

public java.lang.String get_externalClient()

set_externalClient

public void set_externalClient(java.lang.String owner)

get_allowsDynamicCreation

public boolean get_allowsDynamicCreation()

set_allowsDynamicCreation

public void set_allowsDynamicCreation(boolean a)

get_dataString

public java.lang.String get_dataString()

set_dataString

public void set_dataString(java.lang.String s)

setInitData

public void setInitData(Element data)

setStatus

public void setStatus(YWorkItemStatus status)

getWorkItemID

public YWorkItemID getWorkItemID()

getEnablementTime

public java.util.Date getEnablementTime()

getEnablementTimeStr

public java.lang.String getEnablementTimeStr()

getFiringTime

public java.util.Date getFiringTime()

getFiringTimeStr

public java.lang.String getFiringTimeStr()

getStartTime

public java.util.Date getStartTime()

getStartTimeStr

public java.lang.String getStartTimeStr()

getStatus

public YWorkItemStatus getStatus()

getParent

public YWorkItem getParent()

getChildren

public java.util.Set<YWorkItem> getChildren()

getCaseID

public YIdentifier getCaseID()

getTaskID

public java.lang.String getTaskID()

getIDString

public java.lang.String getIDString()

getDeferredChoiceGroupID

public java.lang.String getDeferredChoiceGroupID()

setDeferredChoiceGroupID

public void setDeferredChoiceGroupID(java.lang.String id)

getSpecName

public java.lang.String getSpecName()

getSpecificationID

public YSpecificationID getSpecificationID()

getTimerParameters

public YTimerParameters getTimerParameters()

setTimerParameters

public void setTimerParameters(YTimerParameters params)

hasTimerStarted

public boolean hasTimerStarted()

setTimerStarted

public void setTimerStarted(boolean started)

getTimerExpiry

public long getTimerExpiry()

setTimerExpiry

public void setTimerExpiry(long time)

getTimerStatus

public java.lang.String getTimerStatus()

allowsDynamicCreation

public boolean allowsDynamicCreation()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getExternalClient

public YClient getExternalClient()

getNetRunner

public YNetRunner getNetRunner()

getDataElement

public Element getDataElement()

getDataString

public java.lang.String getDataString()

getTask

public YTask getTask()

setTask

public void setTask(YTask task)

getDocumentation

public java.lang.String getDocumentation()

toXML

public java.lang.String toXML()