org.yawlfoundation.yawl.engine.interfce
Class WorkItemRecord

java.lang.Object
  extended by org.yawlfoundation.yawl.engine.interfce.WorkItemRecord
All Implemented Interfaces:
Cloneable

public class WorkItemRecord
extends Object
implements 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
static String statusComplete
           
static String statusDeadlocked
           
static String statusDiscarded
           
static String statusEnabled
           
static String statusExecuting
           
static String statusFailed
           
static String statusFired
           
static String statusForcedComplete
           
static String statusIsParent
           
static String statusResourceAllocated
           
static String statusResourceOffered
           
static String statusResourceStarted
           
static String statusResourceSuspended
           
static String statusResourceUnoffered
           
static String statusResourceUnresourced
           
static String statusSuspended
           
 
Constructor Summary
WorkItemRecord()
           
WorkItemRecord(String caseID, String taskID, String specURI, String enablementTime, String status)
           
 
Method Summary
 WorkItemRecord clone()
           
 boolean equals(Object o)
           
 String getAllowsDynamicCreation()
           
 String getAssignedTo()
          Deprecated. - use getStartedBy()
 Hashtable<String,String> getAttributeTable()
           
 String getCaseID()
           
 String getCodelet()
           
 String getCompletedBy()
           
 String getCompletionTime()
           
 String getCompletionTimeMs()
           
 String getCustomFormURL()
           
 org.jdom.Element getDataList()
           
 String getDataListString()
           
 String getDeferredChoiceGroupID()
           
 String getDocumentation()
           
 String getEnablementTime()
           
 String getEnablementTimeMs()
           
 String getExtendedAttributes()
           
 String getFiringTime()
           
 String getFiringTimeMs()
           
 String getID()
           
 String getIDForDisplay()
           
 String getLogPredicateCompletion()
           
 String getLogPredicateStarted()
           
 String getParentID()
           
 String getRequiresManualResourcing()
           
 String getResourceStatus()
           
 String getRootCaseID()
           
 String getSpecIdentifier()
           
 String getSpecURI()
           
 String getSpecVersion()
           
 String getStartedBy()
           
 String getStartTime()
           
 String getStartTimeMs()
           
 String getStatus()
           
 String getTag()
           
 String getTaskID()
           
 String getTaskName()
           
 String getTimerExpiry()
           
 String getTimerTrigger()
           
 String getUniqueID()
           
 org.jdom.Element getUpdatedData()
           
 String getWhoStartedMe()
          Deprecated. - use getStartedBy()
 org.jdom.Element getWorkItemData()
          Deprecated. - use getDataList()
 boolean hasDocumentation()
           
 int hashCode()
           
 boolean hasLiveStatus()
           
 boolean hasResourceStatus(String status)
           
 boolean hasStatus(String status)
           
 boolean isAutoTask()
           
 boolean isDeferredChoiceGroupMember()
           
 boolean isDocumentationChanged()
           
 boolean isEdited()
           
 boolean isEnabledOrFired()
           
 void resetDataState()
           
 void restoreAttributeTable()
           
 void restoreDataList()
           
 void setAllowsDynamicCreation(String allows)
           
 void setAssignedTo(String whoStartedMe)
          Deprecated.  
 void setCaseID(String caseID)
           
 void setCodelet(String codelet)
           
 void setCompletedBy(String resource)
           
 void setCompletionTime(String time)
           
 void setCompletionTimeMs(String time)
           
 void setCustomFormURL(String url)
           
 void setDataList(org.jdom.Element dataList)
           
 void setDataListString(String dataStr)
           
 void setDeferredChoiceGroupID(String id)
           
 void setDocumentation(String doco)
           
 void setDocumentationChanged(boolean added)
           
 void setEnablementTime(String time)
           
 void setEnablementTimeMs(String time)
           
 void setExtendedAttributes(Hashtable<String,String> attribs)
           
 void setExtendedAttributes(String attribStr)
           
 void setFiringTime(String time)
           
 void setFiringTimeMs(String time)
           
 void setLogPredicateCompletion(String predicate)
           
 void setLogPredicateStarted(String predicate)
           
 void setRequiresManualResourcing(String manual)
           
 void setResourceStatus(String status)
           
 void setSpecIdentifier(String id)
           
 void setSpecURI(String uri)
           
 void setSpecVersion(String version)
           
 void setStartedBy(String resource)
           
 void setStartTime(String time)
           
 void setStartTimeMs(String time)
           
 void setStatus(String status)
           
 void setTag(String tag)
           
 void setTaskID(String taskID)
           
 void setTaskName(String name)
           
 void setTimerExpiry(String expiry)
           
 void setTimerTrigger(String trigger)
           
 void setUniqueID(String uniqueID)
           
 void setUpdatedData(org.jdom.Element dataListUpdated)
           
 String toString()
           
 String toXML()
           
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

statusEnabled

public static final String statusEnabled
See Also:
Constant Field Values

statusFired

public static final String statusFired
See Also:
Constant Field Values

statusExecuting

public static final String statusExecuting
See Also:
Constant Field Values

statusComplete

public static final String statusComplete
See Also:
Constant Field Values

statusIsParent

public static final String statusIsParent
See Also:
Constant Field Values

statusDeadlocked

public static final String statusDeadlocked
See Also:
Constant Field Values

statusForcedComplete

public static final String statusForcedComplete
See Also:
Constant Field Values

statusFailed

public static final String statusFailed
See Also:
Constant Field Values

statusSuspended

public static final String statusSuspended
See Also:
Constant Field Values

statusDiscarded

public static final String statusDiscarded
See Also:
Constant Field Values

statusResourceOffered

public static final String statusResourceOffered
See Also:
Constant Field Values

statusResourceAllocated

public static final String statusResourceAllocated
See Also:
Constant Field Values

statusResourceStarted

public static final String statusResourceStarted
See Also:
Constant Field Values

statusResourceSuspended

public static final String statusResourceSuspended
See Also:
Constant Field Values

statusResourceUnoffered

public static final String statusResourceUnoffered
See Also:
Constant Field Values

statusResourceUnresourced

public static final String statusResourceUnresourced
See Also:
Constant Field Values
Constructor Detail

WorkItemRecord

public WorkItemRecord()

WorkItemRecord

public WorkItemRecord(String caseID,
                      String taskID,
                      String specURI,
                      String enablementTime,
                      String status)
Method Detail

restoreDataList

public void restoreDataList()

restoreAttributeTable

public void restoreAttributeTable()

resetDataState

public void resetDataState()

setSpecIdentifier

public void setSpecIdentifier(String id)

setSpecVersion

public void setSpecVersion(String version)

setSpecURI

public void setSpecURI(String uri)

setCaseID

public void setCaseID(String caseID)

setTaskID

public void setTaskID(String taskID)

setUniqueID

public void setUniqueID(String uniqueID)

setTaskName

public void setTaskName(String name)

setAllowsDynamicCreation

public void setAllowsDynamicCreation(String allows)

setRequiresManualResourcing

public void setRequiresManualResourcing(String manual)

setCodelet

public void setCodelet(String codelet)

setDeferredChoiceGroupID

public void setDeferredChoiceGroupID(String id)

setExtendedAttributes

public void setExtendedAttributes(Hashtable<String,String> attribs)

setExtendedAttributes

public void setExtendedAttributes(String attribStr)

setEnablementTime

public void setEnablementTime(String time)

setFiringTime

public void setFiringTime(String time)

setStartTime

public void setStartTime(String time)

setCompletionTime

public void setCompletionTime(String time)

setEnablementTimeMs

public void setEnablementTimeMs(String time)

setFiringTimeMs

public void setFiringTimeMs(String time)

setStartTimeMs

public void setStartTimeMs(String time)

setCompletionTimeMs

public void setCompletionTimeMs(String time)

setTimerTrigger

public void setTimerTrigger(String trigger)

setTimerExpiry

public void setTimerExpiry(String expiry)

setStatus

public void setStatus(String status)

setResourceStatus

public void setResourceStatus(String status)

setAssignedTo

public void setAssignedTo(String whoStartedMe)
Deprecated. 


setStartedBy

public void setStartedBy(String resource)

setCompletedBy

public void setCompletedBy(String resource)

setDataList

public void setDataList(org.jdom.Element dataList)

setDataListString

public void setDataListString(String dataStr)

setTag

public void setTag(String tag)

setUpdatedData

public void setUpdatedData(org.jdom.Element dataListUpdated)

setCustomFormURL

public void setCustomFormURL(String url)

setLogPredicateStarted

public void setLogPredicateStarted(String predicate)

setLogPredicateCompletion

public void setLogPredicateCompletion(String predicate)

setDocumentation

public void setDocumentation(String doco)

setDocumentationChanged

public void setDocumentationChanged(boolean added)

getSpecIdentifier

public String getSpecIdentifier()

getSpecVersion

public String getSpecVersion()

getSpecURI

public String getSpecURI()

getCaseID

public String getCaseID()

getTaskID

public String getTaskID()

getUniqueID

public String getUniqueID()

getAllowsDynamicCreation

public String getAllowsDynamicCreation()

getDeferredChoiceGroupID

public String getDeferredChoiceGroupID()

getRequiresManualResourcing

public String getRequiresManualResourcing()

getCodelet

public String getCodelet()

getExtendedAttributes

public String getExtendedAttributes()

getAttributeTable

public Hashtable<String,String> getAttributeTable()

getID

public String getID()

getEnablementTime

public String getEnablementTime()

getFiringTime

public String getFiringTime()

getStartTime

public String getStartTime()

getCompletionTime

public String getCompletionTime()

getEnablementTimeMs

public String getEnablementTimeMs()

getFiringTimeMs

public String getFiringTimeMs()

getStartTimeMs

public String getStartTimeMs()

getCompletionTimeMs

public String getCompletionTimeMs()

getTimerTrigger

public String getTimerTrigger()

getTimerExpiry

public String getTimerExpiry()

getStatus

public String getStatus()

getResourceStatus

public String getResourceStatus()

getAssignedTo

public String getAssignedTo()
Deprecated. - use getStartedBy()


getWhoStartedMe

public String getWhoStartedMe()
Deprecated. - use getStartedBy()


getStartedBy

public String getStartedBy()

getCompletedBy

public String getCompletedBy()

getWorkItemData

public org.jdom.Element getWorkItemData()
Deprecated. - use getDataList()


getDataList

public org.jdom.Element getDataList()

getDataListString

public String getDataListString()

getTag

public String getTag()

getUpdatedData

public org.jdom.Element getUpdatedData()

getIDForDisplay

public String getIDForDisplay()

getTaskName

public String getTaskName()

getDocumentation

public String getDocumentation()

hasDocumentation

public boolean hasDocumentation()

isDocumentationChanged

public boolean isDocumentationChanged()

getRootCaseID

public String getRootCaseID()

getParentID

public String getParentID()

getLogPredicateStarted

public String getLogPredicateStarted()

getLogPredicateCompletion

public String getLogPredicateCompletion()

isEdited

public boolean isEdited()

isDeferredChoiceGroupMember

public boolean isDeferredChoiceGroupMember()

isAutoTask

public boolean isAutoTask()

getCustomFormURL

public String getCustomFormURL()

hasLiveStatus

public boolean hasLiveStatus()

isEnabledOrFired

public boolean isEnabledOrFired()

hasStatus

public boolean hasStatus(String status)

hasResourceStatus

public boolean hasResourceStatus(String status)

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

toXML

public String toXML()

clone

public WorkItemRecord clone()
                     throws CloneNotSupportedException
Overrides:
clone in class Object
Throws:
CloneNotSupportedException


Copyright © 2004-2012 The YAWL Foundation.