Package wt.workflow.work

Class WorkItem

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.workflow.work._WorkItem
wt.workflow.work.WorkItem
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.notify._Notifiable, Notifiable, wt.ownership._Ownable, wt.ownership.Ownable, wt.recent.RecentlyVisited, wt.type._TypeManaged, wt.type.TypeManaged, wt.workflow.work.LWWorkItemIfc
Direct Known Subclasses:
_ProjectWorkItem
@GenAsPersistable(superClass=WTObject.class,interfaces={wt.workflow.work.LWWorkItemIfc.class,wt.ownership.Ownable.class,Notifiable.class,wt.type.TypeManaged.class,wt.recent.RecentlyVisited.class},versions={6766956989929071622L,1803105130206756296L},properties={@GeneratedProperty(name="taskURLPathInfo",type=java.lang.String.class,javaDoc="A string representation of the everything after the gateway portion of the task URL. The actual URL for the task associated with this work item is built as needed by calling the method <code>wt.httpgw.GatewayURL.getURL</code>. <p> The value for this attribute should be created using <code>wt.httpgw.GatewayURL.buildPathInfo</code> or by constructing a work item with the multi argument constructor in this class. <p> Example: Properties params = new Properties(); params.put(\"action\", \"WfTask\"); //Add other query string parameters... String taskURLPathInfo = GatewayURL.buildPathInfo(\"wt.enterprise.URLProcessor\", \"URLTemplateAction\", null, params); WorkItem wi = newWorkItem(); wi.setTaskURL(taskURLPathInfo); @see wt.httpgw.GatewayURL",accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(upperLimit=2000)),@GeneratedProperty(name="role",type=Role.class,supportedAPI=PUBLIC_PRIVATE,javaDoc="The role that the owner will play in completing the work item"),@GeneratedProperty(name="description",type=java.lang.String.class,javaDoc="A description of the work",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="source",type=ObjectReference.class,supportedAPI=PUBLIC_PRIVATE,javaDoc="The source that created this work item",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="priority",type=java.lang.String.class,constraints=@PropertyConstraints(upperLimit=20)),@GeneratedProperty(name="required",type=boolean.class,initialValue="false",javaDoc="Indicates whether or not this work item HAS to be completed"),@GeneratedProperty(name="completedBy",type=java.lang.String.class,supportedAPI=PUBLIC_PRIVATE,javaDoc="The name of the entity that completed this work item. Work can be completed by humans as well as workflow robot activities.",accessors=@PropertyAccessors(setAccess=PRIVATE)),@GeneratedProperty(name="primaryBusinessObject",type=wt.fc.PersistentReference.class,accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="parentWA",type=ObjectReference.class),@GeneratedProperty(name="status",type=WfAssignmentState.class,initialValue="WfAssignmentState.POTENTIAL",supportedAPI=PUBLIC_PRIVATE,javaDoc="State of the assignment. One of {POTENTIAL, ACCEPTED}.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="variablePermissionMap",type=wt.workflow.work.VariablePermissionTable.class,javaDoc="Associates variable names to lists of permissions actually granted to task participant. After task is done all the permissions in the list must be revoked for each variable.",accessors=@PropertyAccessors(getAccess=PROTECTED,setExceptions={}),columnProperties=@ColumnProperties(columnType=SMALL_BLOB)),@GeneratedProperty(name="reassigned",type=boolean.class,initialValue="false",supportedAPI=PUBLIC_PRIVATE,javaDoc="Indicates whether or not this work item has been reassigned."),@GeneratedProperty(name="origOwner",type=ObjectReference.class,javaDoc="The original owner when a task is delegated.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="context",type=ProcessData.class,javaDoc="Input and output data for the execution object. The context is described by a set of named variables (also called \"attributes\" or \"properties\"). These variables can be both read and written by the object. The context for a WorkItem corresponds to all variables in the activity. The workitem owner can update the variables without completing the workitem. The variables in the workitem are communicated to the activity when the workitem is completed.",accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(columnType=INLINE_BLOB)),@GeneratedProperty(name="actionPerformed",type=java.lang.String.class),@GeneratedProperty(name="delegate",type=WTPrincipalReference.class,columnProperties=@ColumnProperties(persistent=false))},tableProperties=@TableProperties(compositeIndex1="ownership.owner.key.id",compositeIndex2="primaryBusinessObject.key.classname",compositeIndex3="source.key.id",compositeIndex4="ownership.owner.key.id + completedBy",oracleTableSize=LARGE),iconProperties=@IconProperties(standardIcon="netmarkets/images/open_work.gif",openIcon="netmarkets/images/open_work.gif")) public class WorkItem extends _WorkItem
The WorkItem class represents discreet units of work owned by principals. If the work item is owned by a group, any member of the group may satisfy the work requirement.

A work item has an associated task which is accessed through a URL. The task provides a context to help the user complete the work item.

The WorkflowService should be used to mark work items complete instead of directly calling setComplete.

Use the newWorkItem static factory method(s), not the WorkItem constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Method Details

    • isComplete

      public boolean isComplete()
      Indicates whether this work item has been completed.

      Supported API: true
      Returns:
      boolean

    • getPBORef

      public WTReference getPBORef() throws WTException
      Gives WTReference of PrimaryObjectReference

      Supported API: true
      Returns:
      reference
      Throws:
      WTException