com.ibm.task.api

Interface TaskActions


  1. public interface TaskActions
This interface defines symbolic constants for all actions that can be performed on task instances. These constants are to be used when determining the actions allowed in the current task instance state. Currently allowed actions are returned when calling the getAvailableActions() or getAvailableActionFlags() methods for a task instance.
Since:
7.0 - introduced in 5.1

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
CALLTASK
Symbolic constant for task instance action call task.
  1. static
  2. int
CANCELCLAIM
Symbolic constant for task instance action cancel claim.
  1. static
  2. int
CLAIM
Symbolic constant for task instance action claim.
  1. static
  2. int
COMPLETE
Symbolic constant for task instance action complete.
  1. static
  2. int
COMPLETEWITHFOLLOWONTASK
Symbolic constant for task instance action complete the current task and start a previously created task as follow-on task.
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
CREATEFAULTMESSAGE
Symbolic constant for task instance action create fault message.
  1. static
  2. int
CREATEINPUTMESSAGE
Symbolic constant for task instance action create input message.
  1. static
  2. int
CREATEMESSAGE
Deprecated. Use CREATEINPUTMESSAGE, CREATEOUTPUTMESSAGE, CREATEFAULTMESSAGE.
  1. static
  2. int
CREATEOUTPUTMESSAGE
Symbolic constant for task instance action create output message.
  1. static
  2. int
CREATEWORKITEM
Symbolic constant for task instance action create work item.
  1. static
  2. int
DELETE
Symbolic constant for task instance action delete task.
  1. static
  2. int
DELETEWORKITEM
Symbolic constant for task instance action delete work item.
  1. static
  2. int
GETCUSTOMPROPERTY
Symbolic constant for task instance action get custom property.
  1. static
  2. int
GETDOCUMENTATION
Symbolic constant for task instance action get documentation.
  1. static
  2. int
GETFAULTMESSAGE
Symbolic constant for task instance action get fault message.
  1. static
  2. int
GETFAULTNAMES
Symbolic constant for task instance action get fault names.
  1. static
  2. int
GETINPUTMESSAGE
Symbolic constant for task instance action get input message.
  1. static
  2. int
GETOUTPUTMESSAGE
Symbolic constant for task instance action get output message.
  1. static
  2. int
GETROLEINFO
Symbolic constant for task instance action to retrieve role related information.
  1. static
  2. int
GETTASK
Symbolic constant for task instance action get task.
  1. static
  2. int
GETTASKINSTANCE
Deprecated. Use GETTASK.
  1. static
  2. int
GETUISETTINGS
Symbolic constant for task instance action get UI settings.
  1. static
  2. int
RESTARTTASK
Symbolic constant for task instance action restart task.
  1. static
  2. int
RESUME
Symbolic constant for task instance action resume task.
  1. static
  2. int
SETCUSTOMPROPERTY
Symbolic constant for task instance action set custom properties.
  1. static
  2. int
SETFAULTMESSAGE
Symbolic constant for task instance action set fault message.
  1. static
  2. int
SETINPUTMESSAGE
Symbolic constant for task instance action set input message.
  1. static
  2. int
SETOUTPUTMESSAGE
Symbolic constant for task instance action set output message.
  1. static
  2. int
SETTASKREAD
Symbolic constant for task instance action set task read.
  1. static
  2. int
STARTTASK
Symbolic constant for task instance action start task.
  1. static
  2. int
STARTTASKASSUBTASK
Symbolic constant for task instance action start task as subtask.
  1. static
  2. int
SUSPEND
Symbolic constant for task instance action suspend task.
  1. static
  2. int
SUSPENDWITHCANCELCLAIM
Symbolic constant for task instance action suspend task and later cancelClaim.
  1. static
  2. int
TERMINATE
Symbolic constant for task instance action terminate task.
  1. static
  2. int
TRANSFERTOWORKBASKET
Symbolic constant for task instance action transfer to work basket.
  1. static
  2. int
TRANSFERWORKITEM
Symbolic constant for task instance action transfer work item.
  1. static
  2. int
UPDATE
Symbolic constant for task instance action update task.
  1. static
  2. int
UPDATEINACTIVETASK
Symbolic constant for task instance action update inactive task.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

CLAIM

  1. static final int CLAIM
Symbolic constant for task instance action claim.
Since:
5.1
See Also:

COMPLETE

  1. static final int COMPLETE
Symbolic constant for task instance action complete.
Since:
5.1
See Also:

CANCELCLAIM

  1. static final int CANCELCLAIM
Symbolic constant for task instance action cancel claim.
Since:
5.1
See Also:

SETOUTPUTMESSAGE

  1. static final int SETOUTPUTMESSAGE
Symbolic constant for task instance action set output message.
Since:
5.1
See Also:

SETCUSTOMPROPERTY

  1. static final int SETCUSTOMPROPERTY
Symbolic constant for task instance action set custom properties.
Since:
5.1
See Also:

GETOUTPUTMESSAGE

  1. static final int GETOUTPUTMESSAGE
Symbolic constant for task instance action get output message.
Since:
5.1
See Also:

GETINPUTMESSAGE

  1. static final int GETINPUTMESSAGE
Symbolic constant for task instance action get input message.
Since:
5.1
See Also:

GETFAULTMESSAGE

  1. static final int GETFAULTMESSAGE
Symbolic constant for task instance action get fault message.
Since:
5.1
See Also:

GETCUSTOMPROPERTY

  1. static final int GETCUSTOMPROPERTY
Symbolic constant for task instance action get custom property. Includes getCustomPropertyNames() and getCustomProperties().
Since:
5.1
See Also:

GETTASKINSTANCE

  1. static final int GETTASKINSTANCE
Deprecated. Use GETTASK.
Symbolic constant for task instance action get task instance.
Since:
5.1
See Also:

GETUISETTINGS

  1. static final int GETUISETTINGS
Symbolic constant for task instance action get UI settings.
Since:
5.1
See Also:

SETFAULTMESSAGE

  1. static final int SETFAULTMESSAGE
Symbolic constant for task instance action set fault message.
Since:
5.1
See Also:

CREATEMESSAGE

  1. static final int CREATEMESSAGE
Deprecated. Use CREATEINPUTMESSAGE, CREATEOUTPUTMESSAGE, CREATEFAULTMESSAGE.
Symbolic constant for task instance action create message.
Since:
5.1
See Also:

CREATEWORKITEM

  1. static final int CREATEWORKITEM
Symbolic constant for task instance action create work item.
Since:
5.1
See Also:

DELETEWORKITEM

  1. static final int DELETEWORKITEM
Symbolic constant for task instance action delete work item.
Since:
5.1
See Also:

TRANSFERWORKITEM

  1. static final int TRANSFERWORKITEM
Symbolic constant for task instance action transfer work item.
Since:
5.1
See Also:

GETFAULTNAMES

  1. static final int GETFAULTNAMES
Symbolic constant for task instance action get fault names.
Since:
5.1
See Also:

CALLTASK

  1. static final int CALLTASK
Symbolic constant for task instance action call task.
Since:
6.0
See Also:

CREATEFAULTMESSAGE

  1. static final int CREATEFAULTMESSAGE
Symbolic constant for task instance action create fault message.
Since:
6.0
See Also:

CREATEINPUTMESSAGE

  1. static final int CREATEINPUTMESSAGE
Symbolic constant for task instance action create input message.
Since:
6.0
See Also:

CREATEOUTPUTMESSAGE

  1. static final int CREATEOUTPUTMESSAGE
Symbolic constant for task instance action create output message.
Since:
6.0
See Also:

DELETE

  1. static final int DELETE
Symbolic constant for task instance action delete task.
Since:
6.0
See Also:

GETDOCUMENTATION

  1. static final int GETDOCUMENTATION
Symbolic constant for task instance action get documentation.
Since:
6.0
See Also:

GETTASK

  1. static final int GETTASK
Symbolic constant for task instance action get task.
Since:
6.0
See Also:

STARTTASK

  1. static final int STARTTASK
Symbolic constant for task instance action start task.
Since:
6.0
See Also:

RESTARTTASK

  1. static final int RESTARTTASK
Symbolic constant for task instance action restart task.
Since:
6.2.0
See Also:

RESUME

  1. static final int RESUME
Symbolic constant for task instance action resume task.
Since:
6.0
See Also:

COMPLETEWITHFOLLOWONTASK

  1. static final int COMPLETEWITHFOLLOWONTASK
Symbolic constant for task instance action complete the current task and start a previously created task as follow-on task.
Since:
6.0.2
See Also:

STARTTASKASSUBTASK

  1. static final int STARTTASKASSUBTASK
Symbolic constant for task instance action start task as subtask.
Since:
6.0.2
See Also:

SUSPEND

  1. static final int SUSPEND
Symbolic constant for task instance action suspend task.
Since:
6.0
See Also:

TERMINATE

  1. static final int TERMINATE
Symbolic constant for task instance action terminate task.
Since:
6.0
See Also:

UPDATE

  1. static final int UPDATE
Symbolic constant for task instance action update task.
Since:
6.0
See Also:

GETROLEINFO

  1. static final int GETROLEINFO
Symbolic constant for task instance action to retrieve role related information. States whether getUsersInRole() or isUserInRole() can be called.
Since:
6.0
See Also:

UPDATEINACTIVETASK

  1. static final int UPDATEINACTIVETASK
Symbolic constant for task instance action update inactive task.
Since:
6.0
See Also:

SUSPENDWITHCANCELCLAIM

  1. static final int SUSPENDWITHCANCELCLAIM
Symbolic constant for task instance action suspend task and later cancelClaim.
Since:
6.0.2
See Also:

SETINPUTMESSAGE

  1. static final int SETINPUTMESSAGE
Symbolic constant for task instance action set input message.
Since:
6.1.2
See Also:

TRANSFERTOWORKBASKET

  1. static final int TRANSFERTOWORKBASKET
Symbolic constant for task instance action transfer to work basket.
Since:
7.0
See Also:

SETTASKREAD

  1. static final int SETTASKREAD
Symbolic constant for task instance action set task read.
Since:
7.0
See Also: