org.yawlfoundation.yawl.engine.interfce

Class WorkItemRecord

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.WorkItemRecord

All Implemented Interfaces:

java.lang.Cloneable

public class WorkItemRecord
extends java.lang.Object
implements java.lang.Cloneable

A 'stringified' record of a workitem for passing across various HTTP interfaces

Author:

Lachlan Aldred Date: 2/02/2004 Time: 18:30:18 Extended & refactored for version 2.0 by Michael Adams Last Date: 27/05/2008

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	statusComplete
static java.lang.String	statusDeadlocked
static java.lang.String	statusDiscarded
static java.lang.String	statusEnabled
static java.lang.String	statusExecuting
static java.lang.String	statusFailed
static java.lang.String	statusFired
static java.lang.String	statusForcedComplete
static java.lang.String	statusIsParent
static java.lang.String	statusResourceAllocated
static java.lang.String	statusResourceOffered
static java.lang.String	statusResourceStarted
static java.lang.String	statusResourceSuspended
static java.lang.String	statusResourceUnoffered
static java.lang.String	statusResourceUnresourced
static java.lang.String	statusSuspended

Constructor Summary

Constructors

Constructor and Description
WorkItemRecord()
WorkItemRecord(java.lang.String caseID, java.lang.String taskID, java.lang.String specURI, java.lang.String status)

Method Summary

Modifier and Type	Method and Description
WorkItemRecord	clone()
boolean	equals(java.lang.Object o)
java.lang.String	getAllowsDynamicCreation()
java.lang.String	getAssignedTo() Deprecated. - use getStartedBy()
java.util.Map<java.lang.String,java.lang.String>	getAttributeTable()
java.lang.String	getCaseID()
java.lang.String	getCodelet()
java.lang.String	getCompletedBy()
java.lang.String	getCompletionTime()
java.lang.String	getCompletionTimeMs()
java.lang.String	getCustomFormURL()
Element	getDataList()
java.lang.String	getDataListString()
java.lang.String	getDeferredChoiceGroupID()
java.lang.String	getDocumentation()
java.lang.String	getEnablementTime()
java.lang.String	getEnablementTimeMs()
java.lang.String	getFiringTime()
java.lang.String	getFiringTimeMs()
java.lang.String	getID()
java.lang.String	getIDForDisplay()
java.lang.String	getLogPredicateCompletion()
java.lang.String	getLogPredicateStarted()
java.lang.String	getNetID()
java.lang.String	getParentID()
java.lang.String	getRequiresManualResourcing()
java.lang.String	getResourceStatus()
java.lang.String	getRootCaseID()
java.lang.String	getSpecIdentifier()
java.lang.String	getSpecURI()
java.lang.String	getSpecVersion()
java.lang.String	getStartedBy()
java.lang.String	getStartTime()
java.lang.String	getStartTimeMs()
java.lang.String	getStatus()
java.lang.String	getTag()
java.lang.String	getTaskID()
java.lang.String	getTaskName()
java.lang.String	getTimerExpiry()
java.lang.String	getTimerTrigger()
java.lang.String	getUniqueID()
Element	getUpdatedData()
java.lang.String	getWhoStartedMe() Deprecated. - use getStartedBy()
Element	getWorkItemData() Deprecated. - use getDataList()
boolean	hasDocumentation()
int	hashCode()
boolean	hasLiveStatus()
boolean	hasResourceStatus(java.lang.String status)
boolean	hasStatus(java.lang.String status)
boolean	isAutoTask()
boolean	isDeferredChoiceGroupMember()
boolean	isDocumentationChanged()
boolean	isDynamicCreationAllowed()
boolean	isEdited()
boolean	isEnabledOrFired()
boolean	isManualResourcingRequired()
void	resetDataState()
void	setAllowsDynamicCreation(java.lang.String allows)
void	setAssignedTo(java.lang.String whoStartedMe) Deprecated.
void	setCaseID(java.lang.String caseID)
void	setCodelet(java.lang.String codelet)
void	setCompletedBy(java.lang.String resource)
void	setCompletionTimeMs(java.lang.String time)
void	setCustomFormURL(java.lang.String url)
void	setDataList(Element dataList)
void	setDeferredChoiceGroupID(java.lang.String id)
void	setDocumentation(java.lang.String doco)
void	setDocumentationChanged(boolean added)
void	setEnablementTimeMs(java.lang.String time)
void	setExtendedAttributes(java.util.Map<java.lang.String,java.lang.String> attrMap)
void	setFiringTimeMs(java.lang.String time)
void	setLogPredicateCompletion(java.lang.String predicate)
void	setLogPredicateStarted(java.lang.String predicate)
void	setRequiresManualResourcing(java.lang.String manual)
void	setResourceStatus(java.lang.String status)
void	setSpecIdentifier(java.lang.String id)
void	setSpecURI(java.lang.String uri)
void	setSpecVersion(java.lang.String version)
void	setStartedBy(java.lang.String resource)
void	setStartTimeMs(java.lang.String time)
void	setStatus(java.lang.String status)
void	setTag(java.lang.String tag)
void	setTaskID(java.lang.String taskID)
void	setTaskName(java.lang.String name)
void	setTimerExpiry(java.lang.String expiry)
void	setTimerTrigger(java.lang.String trigger)
void	setUniqueID(java.lang.String uniqueID)
void	setUpdatedData(Element dataListUpdated)
java.lang.String	toString()
java.lang.String	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

statusEnabled

public static final java.lang.String statusEnabled

See Also:

Constant Field Values

statusFired

public static final java.lang.String statusFired

See Also:

Constant Field Values

statusExecuting

public static final java.lang.String statusExecuting

See Also:

Constant Field Values

statusComplete

public static final java.lang.String statusComplete

See Also:

Constant Field Values

statusIsParent

public static final java.lang.String statusIsParent

See Also:

Constant Field Values

statusDeadlocked

public static final java.lang.String statusDeadlocked

See Also:

Constant Field Values

statusForcedComplete

public static final java.lang.String statusForcedComplete

See Also:

Constant Field Values

statusFailed

public static final java.lang.String statusFailed

See Also:

Constant Field Values

statusSuspended

public static final java.lang.String statusSuspended

See Also:

Constant Field Values

statusDiscarded

public static final java.lang.String statusDiscarded

See Also:

Constant Field Values

statusResourceOffered

public static final java.lang.String statusResourceOffered

See Also:

Constant Field Values

statusResourceAllocated

public static final java.lang.String statusResourceAllocated

See Also:

Constant Field Values

statusResourceStarted

public static final java.lang.String statusResourceStarted

See Also:

Constant Field Values

statusResourceSuspended

public static final java.lang.String statusResourceSuspended

See Also:

Constant Field Values

statusResourceUnoffered

public static final java.lang.String statusResourceUnoffered

See Also:

Constant Field Values

statusResourceUnresourced

public static final java.lang.String statusResourceUnresourced

See Also:

Constant Field Values

Constructor Detail

WorkItemRecord

public WorkItemRecord()

WorkItemRecord

public WorkItemRecord(java.lang.String caseID,
                      java.lang.String taskID,
                      java.lang.String specURI,
                      java.lang.String status)

Method Detail

resetDataState

public void resetDataState()

setSpecIdentifier

public void setSpecIdentifier(java.lang.String id)

setSpecVersion

public void setSpecVersion(java.lang.String version)

setSpecURI

public void setSpecURI(java.lang.String uri)

setCaseID

public void setCaseID(java.lang.String caseID)

setTaskID

public void setTaskID(java.lang.String taskID)

setUniqueID

public void setUniqueID(java.lang.String uniqueID)

setTaskName

public void setTaskName(java.lang.String name)

setAllowsDynamicCreation

public void setAllowsDynamicCreation(java.lang.String allows)

setRequiresManualResourcing

public void setRequiresManualResourcing(java.lang.String manual)

setCodelet

public void setCodelet(java.lang.String codelet)

setDeferredChoiceGroupID

public void setDeferredChoiceGroupID(java.lang.String id)

setExtendedAttributes

public void setExtendedAttributes(java.util.Map<java.lang.String,java.lang.String> attrMap)

setEnablementTimeMs

public void setEnablementTimeMs(java.lang.String time)

setFiringTimeMs

public void setFiringTimeMs(java.lang.String time)

setStartTimeMs

public void setStartTimeMs(java.lang.String time)

setCompletionTimeMs

public void setCompletionTimeMs(java.lang.String time)

setTimerTrigger

public void setTimerTrigger(java.lang.String trigger)

setTimerExpiry

public void setTimerExpiry(java.lang.String expiry)

setStatus

public void setStatus(java.lang.String status)

setResourceStatus

public void setResourceStatus(java.lang.String status)

setAssignedTo

public void setAssignedTo(java.lang.String whoStartedMe)

Deprecated.

setStartedBy

public void setStartedBy(java.lang.String resource)

setCompletedBy

public void setCompletedBy(java.lang.String resource)

setDataList

public void setDataList(Element dataList)

setTag

public void setTag(java.lang.String tag)

setUpdatedData

public void setUpdatedData(Element dataListUpdated)

setCustomFormURL

public void setCustomFormURL(java.lang.String url)

setLogPredicateStarted

public void setLogPredicateStarted(java.lang.String predicate)

setLogPredicateCompletion

public void setLogPredicateCompletion(java.lang.String predicate)

setDocumentation

public void setDocumentation(java.lang.String doco)

setDocumentationChanged

public void setDocumentationChanged(boolean added)

getSpecIdentifier

public java.lang.String getSpecIdentifier()

getSpecVersion

public java.lang.String getSpecVersion()

getSpecURI

public java.lang.String getSpecURI()

getCaseID

public java.lang.String getCaseID()

getTaskID

public java.lang.String getTaskID()

getUniqueID

public java.lang.String getUniqueID()

getAllowsDynamicCreation

public java.lang.String getAllowsDynamicCreation()

isDynamicCreationAllowed

public boolean isDynamicCreationAllowed()

getDeferredChoiceGroupID

public java.lang.String getDeferredChoiceGroupID()

getRequiresManualResourcing

public java.lang.String getRequiresManualResourcing()

isManualResourcingRequired

public boolean isManualResourcingRequired()

getCodelet

public java.lang.String getCodelet()

getAttributeTable

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

getID

public java.lang.String getID()

getEnablementTime

public java.lang.String getEnablementTime()

getFiringTime

public java.lang.String getFiringTime()

getStartTime

public java.lang.String getStartTime()

getCompletionTime

public java.lang.String getCompletionTime()

getEnablementTimeMs

public java.lang.String getEnablementTimeMs()

getFiringTimeMs

public java.lang.String getFiringTimeMs()

getStartTimeMs

public java.lang.String getStartTimeMs()

getCompletionTimeMs

public java.lang.String getCompletionTimeMs()

getTimerTrigger

public java.lang.String getTimerTrigger()

getTimerExpiry

public java.lang.String getTimerExpiry()

getStatus

public java.lang.String getStatus()

getResourceStatus

public java.lang.String getResourceStatus()

getAssignedTo

public java.lang.String getAssignedTo()

Deprecated. - use getStartedBy()

getWhoStartedMe

public java.lang.String getWhoStartedMe()

Deprecated. - use getStartedBy()

getStartedBy

public java.lang.String getStartedBy()

getCompletedBy

public java.lang.String getCompletedBy()

getWorkItemData

public Element getWorkItemData()

Deprecated. - use getDataList()

getDataList

public Element getDataList()

getDataListString

public java.lang.String getDataListString()

getTag

public java.lang.String getTag()

getUpdatedData

public Element getUpdatedData()

getIDForDisplay

public java.lang.String getIDForDisplay()

getTaskName

public java.lang.String getTaskName()

getDocumentation

public java.lang.String getDocumentation()

hasDocumentation

public boolean hasDocumentation()

isDocumentationChanged

public boolean isDocumentationChanged()

getRootCaseID

public java.lang.String getRootCaseID()

getNetID

public java.lang.String getNetID()

getParentID

public java.lang.String getParentID()

getLogPredicateStarted

public java.lang.String getLogPredicateStarted()

getLogPredicateCompletion

public java.lang.String getLogPredicateCompletion()

isEdited

public boolean isEdited()

isDeferredChoiceGroupMember

public boolean isDeferredChoiceGroupMember()

isAutoTask

public boolean isAutoTask()

getCustomFormURL

public java.lang.String getCustomFormURL()

hasLiveStatus

public boolean hasLiveStatus()

isEnabledOrFired

public boolean isEnabledOrFired()

hasStatus

public boolean hasStatus(java.lang.String status)

hasResourceStatus

public boolean hasResourceStatus(java.lang.String status)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toXML

public java.lang.String toXML()

clone

public WorkItemRecord clone()
                     throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException