|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.object.PersistentObject
com.waveset.object.WorkItem
public class WorkItem
This class is used to represent the state of a work list item. These were formerly called "workflow tasks" but the name was changed to prevent confusion with TaskInstance.
A work item is created for each manual Action in the workfow process. Work items are "owned" by a particular Administrator, and the GUI is expected to provide a way to examine the assigned work items and edit them.
The work item will contain a set of variable values copied from the running case. By default it will contain a complete set of all workflow variables, this can be restricted by setting the "exposedVariables" and "editableVariables" lists in the associated action definition.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.waveset.object.PersistentObject |
---|
PersistentObject.Comparator, PersistentObject.InitialInstance |
Field Summary | |
---|---|
static java.lang.String |
APPROVAL
|
static java.lang.String |
ATT_IGNORE_TIMEOUT
|
static java.lang.String |
ATT_ITEM_TYPE
|
static java.lang.String |
ATT_REQUEST
|
static java.lang.String |
ATT_REQUESTER
|
static java.lang.String |
ATT_SYNCEXEC
|
static java.lang.String |
ATT_TIMEOUT
|
static java.lang.String |
ATT_TRANSIENT
|
static java.lang.String |
code_id
|
static java.lang.String |
EL_DELEGATORS
|
static java.lang.String |
EL_DESCRIPTION
|
static java.lang.String |
EL_FORMREF
|
static java.lang.String |
EL_TASKREF
|
static java.lang.String |
EL_VARIABLES
|
static java.lang.String |
EL_VIEWS
|
static java.lang.String |
REVIEW
|
static java.lang.String |
SUSPEND
|
static java.lang.String |
VAR_COMMENTS
The name of a variable that may be used to place explanitory comments in the work item. |
static java.lang.String |
WIZARD
|
Fields inherited from class com.waveset.object.PersistentObject |
---|
INITIAL_OBJECT_VERSION |
Constructor Summary | |
---|---|
WorkItem()
Build an empty work item. |
|
WorkItem(org.w3c.dom.Element e)
Build a work item from its XML representation. |
Method Summary | |
---|---|
void |
clearDirty()
Clear the dirty flag. |
java.lang.String |
getActivityName()
Get the name of the associated workflow process activity. |
com.waveset.object.WFCase.Result |
getCaseResult()
|
java.util.List |
getDelegatorRefs()
Get the delegators (list of User ObjectRefs) of this work item, if any. |
java.lang.String |
getDescription()
|
com.waveset.object.Form |
getForm()
Get the form for this work item. |
com.waveset.object.ObjectRef |
getFormRef()
Get the form reference. |
java.lang.String |
getItemType()
|
com.waveset.object.Form |
getLocalForm()
Get the local form. |
java.lang.String |
getOwner()
Get the owner of this item. |
com.sun.idm.object.IDMObjectClass |
getPrimaryObjectClass()
|
java.lang.String |
getProcessName()
Get the name of the associated workflow process. |
java.util.ArrayList |
getReferences()
Return the list of references within this object. |
java.lang.String |
getRequest()
|
java.lang.String |
getRequester()
|
WSAttributes |
getSummaryAttributes()
|
java.lang.String |
getTargetId()
Get the optional target id. |
java.lang.String |
getTargetName()
Get the optional target id. |
java.lang.String |
getTargetObjectClass()
Get the optional target object class name. |
com.waveset.object.TaskInstance |
getTask()
Get the resolved TaskInstance that contains our WorkflowCase. |
com.waveset.object.ObjectRef |
getTaskRef()
Get a reference to the TaskInstance that contains our WorkflowCase. |
java.util.Date |
getTimeout()
Get the work item timeout. |
java.lang.String |
getTrackingId()
Get the optional tracking id. |
com.waveset.object.Type |
getType()
Returns the associated Type object. |
java.lang.Object |
getVariable(com.waveset.object.Attribute attr)
Get the value of a variable. |
java.lang.Object |
getVariable(java.lang.String name)
Get the value of a variable. |
GenericObject |
getVariables()
Get the entire variable table. |
java.util.List |
getViews()
|
boolean |
isAutoCompleted()
Can this work item be completed manually? |
boolean |
isComplete()
Test the completion state of the item. |
boolean |
isDirty()
Test the dirty flag. |
boolean |
isIgnoreTimeout()
|
boolean |
isSyncExec()
|
boolean |
isTransient()
|
java.util.List |
listQueryableAttributes()
|
java.util.List |
listQueryableReferenceAttributes()
|
java.util.List |
listSummaryAttributes()
Returns the complete list of defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each). |
void |
setActivityName(java.lang.String s)
Get the name of the associated workflow process activity. |
void |
setAutoCompleted(boolean b)
Set the autoCompleted state of the item. |
void |
setCaseResult(com.waveset.object.WFCase.Result r)
|
void |
setComplete(boolean b)
Set the completion state of the item. |
void |
setDelegatorRefs(java.util.List delegatorRefs)
Set the delegators (list of User ObjectRefs) of this work item, if any |
void |
setDescription(java.lang.String s)
|
void |
setFormRef(com.waveset.object.ObjectRef ref)
Set the form reference. |
void |
setIgnoreTimeout(boolean b)
|
void |
setItemType(java.lang.String s)
|
void |
setLocalForm(com.waveset.object.Form f)
Set the local form. |
void |
setOwner(java.lang.String s)
Set the owner of this item. |
void |
setProcessName(java.lang.String s)
Set the name of the associated workflow process. |
void |
setRequest(java.lang.String s)
|
void |
setRequester(java.lang.String s)
|
void |
setSyncExec(boolean b)
|
void |
setTargetId(java.lang.String id)
Set an optional target ID. |
void |
setTargetName(java.lang.String name)
Set an optional target name. |
void |
setTargetObjectClass(java.lang.String name)
Set an optional target object class name. |
void |
setTask(com.waveset.object.TaskInstance t)
Set the resolved TaskInstance that contains our WorkflowCase. |
void |
setTaskRef(com.waveset.object.ObjectRef ref)
Set the reference to the TaskInstance that contains our WorkflowCase. |
void |
setTimeout(java.util.Date d)
Set the work item timeout. |
void |
setTrackingId(java.lang.String id)
Set an optional tracking ID. |
void |
setTransient(boolean b)
|
void |
setVariable(java.lang.String name,
java.lang.Object value)
Set one variable. |
void |
setVariables(GenericObject src)
Bulk assignment of variables. |
void |
setViews(java.util.List views)
|
void |
visit(com.waveset.object.Visitor v)
Visitor interface. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String APPROVAL
public static final java.lang.String ATT_IGNORE_TIMEOUT
public static final java.lang.String ATT_ITEM_TYPE
public static final java.lang.String ATT_REQUEST
public static final java.lang.String ATT_REQUESTER
public static final java.lang.String ATT_SYNCEXEC
public static final java.lang.String ATT_TIMEOUT
public static final java.lang.String ATT_TRANSIENT
public static final java.lang.String code_id
public static final java.lang.String EL_DELEGATORS
public static final java.lang.String EL_DESCRIPTION
public static final java.lang.String EL_FORMREF
public static final java.lang.String EL_TASKREF
public static final java.lang.String EL_VARIABLES
public static final java.lang.String EL_VIEWS
public static final java.lang.String REVIEW
public static final java.lang.String SUSPEND
public static final java.lang.String VAR_COMMENTS
public static final java.lang.String WIZARD
Constructor Detail |
---|
public WorkItem()
public WorkItem(org.w3c.dom.Element e) throws com.waveset.util.WavesetException
e
- xml element
com.waveset.util.WavesetException
- if e can't be parsed.Method Detail |
---|
public void clearDirty()
public java.lang.String getActivityName()
public com.waveset.object.WFCase.Result getCaseResult()
public java.util.List getDelegatorRefs()
public java.lang.String getDescription()
public com.waveset.object.Form getForm() throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
public com.waveset.object.ObjectRef getFormRef()
public java.lang.String getItemType()
public com.waveset.object.Form getLocalForm()
public java.lang.String getOwner()
public com.sun.idm.object.IDMObjectClass getPrimaryObjectClass()
getPrimaryObjectClass
in class PersistentObject
public java.lang.String getProcessName()
public java.util.ArrayList getReferences()
getReferences
in class PersistentObject
public java.lang.String getRequest()
public java.lang.String getRequester()
public WSAttributes getSummaryAttributes()
getSummaryAttributes
in class PersistentObject
attribute values
to be displayed when this object appears in a list.
The WSAttributes
contains
a WSAttribute
for each summary attribute.
Each WSAttribute
may contain multiple values.
Any subclass of PersistentObject that overrides this method
should first invoke super.getSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
If a subclass wants to expose a different set of summary attributes,
that subclass should override {@link #listSummaryAttributes}.
In order to supply values for summary attributes
that may not be available in PersistentObject
(e.g., from a field specified to that subclass),
such a subclass may also override {@link #getAttributeValues(String)}.
A subclass should not need to override this method
(except to limit the number of values for a summary attribute).
public java.lang.String getTargetId()
public java.lang.String getTargetName()
public java.lang.String getTargetObjectClass()
public com.waveset.object.TaskInstance getTask() throws com.waveset.util.WavesetException
com.waveset.util.WavesetException
public com.waveset.object.ObjectRef getTaskRef()
public java.util.Date getTimeout()
public java.lang.String getTrackingId()
public com.waveset.object.Type getType()
getType
in class PersistentObject
public java.lang.Object getVariable(com.waveset.object.Attribute attr)
public java.lang.Object getVariable(java.lang.String name)
public GenericObject getVariables()
public java.util.List getViews()
public boolean isAutoCompleted()
public boolean isComplete()
public boolean isDirty()
public boolean isIgnoreTimeout()
public boolean isSyncExec()
public boolean isTransient()
public java.util.List listQueryableAttributes()
listQueryableAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as queryable attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listQueryableAttributes()
to ensure that the subclass includes queryable attributes
that are common to all PersistentObjects.
public java.util.List listQueryableReferenceAttributes()
listQueryableReferenceAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as queryable attributes
and for which each value is a reference to another persistent object.public java.util.List listSummaryAttributes()
PersistentObject
defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
Any subclass that overrides this implementation must also consider the length of the summary string that will be generated from these attributes.
listSummaryAttributes
in class PersistentObject
defined attributes
that this type of persistent object exposes as summary attributes
(regardless of whether this particular object has a value for each).
Any subclass of PersistentObject that overrides this method
should first invoke super.listSummaryAttributes()
to ensure that the subclass includes summary attributes
that are common to all PersistentObjects.
Constants.MAX_SUMMARY_STRING_LENGTH
,
PersistentObject.getSummaryString()
public void setActivityName(java.lang.String s)
public void setAutoCompleted(boolean b)
public void setCaseResult(com.waveset.object.WFCase.Result r)
public void setComplete(boolean b)
This must be called by an application that provides a "work list" to the owner. The owner may decide to complete without modifying variables, modify variables without completing or both.
public void setDelegatorRefs(java.util.List delegatorRefs)
delegators
- public void setDescription(java.lang.String s)
public void setFormRef(com.waveset.object.ObjectRef ref)
public void setIgnoreTimeout(boolean b)
public void setItemType(java.lang.String s)
public void setLocalForm(com.waveset.object.Form f)
public void setOwner(java.lang.String s)
This will be set up originally by the workflow case, it may be changed after it has been created if you want to reassign the item to someone else. // *
// * Hmm, might want to use an ObjectRef here to support // * Administrator account rename.
public void setProcessName(java.lang.String s)
public void setRequest(java.lang.String s)
public void setRequester(java.lang.String s)
public void setSyncExec(boolean b)
public void setTargetId(java.lang.String id)
public void setTargetName(java.lang.String name)
public void setTargetObjectClass(java.lang.String name)
public void setTask(com.waveset.object.TaskInstance t)
public void setTaskRef(com.waveset.object.ObjectRef ref)
public void setTimeout(java.util.Date d)
public void setTrackingId(java.lang.String id)
public void setTransient(boolean b)
public void setVariable(java.lang.String name, java.lang.Object value)
public void setVariables(GenericObject src)
public void setViews(java.util.List views)
public void visit(com.waveset.object.Visitor v) throws com.waveset.util.WavesetException
visit
in class PersistentObject
v
- Visitor for this persistent object.
com.waveset.util.WavesetException
- if there's a problem from visitPersistentObject
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |