com.ibm.task.api
Interface TaskActions


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:
5.1

Field Summary
static int CALLTASK
          Symbolic constant for task instance action call task.
static int CANCELCLAIM
          Symbolic constant for task instance action cancel claim.
static int CLAIM
          Symbolic constant for task instance action claim.
static int COMPLETE
          Symbolic constant for task instance action complete.
static java.lang.String COPYRIGHT
           
static int CREATEFAULTMESSAGE
          Symbolic constant for task instance action create fault message.
static int CREATEINPUTMESSAGE
          Symbolic constant for task instance action create input message.
static int CREATEMESSAGE
          Deprecated. Use CREATEINPUTMESSAGE, CREATEOUTPUTMESSAGE, CREATEFAULTMESSAGE.
static int CREATEOUTPUTMESSAGE
          Symbolic constant for task instance action create output message.
static int CREATEWORKITEM
          Symbolic constant for task instance action create work item.
static int DELETE
          Symbolic constant for task instance action delete task.
static int DELETEWORKITEM
          Symbolic constant for task instance action delete work item.
static int GETCUSTOMPROPERTY
          Symbolic constant for task instance action get custom property.
static int GETDOCUMENTATION
          Symbolic constant for task instance action get documentation.
static int GETFAULTMESSAGE
          Symbolic constant for task instance action get fault message.
static int GETFAULTNAMES
          Symbolic constant for task instance action get fault names.
static int GETINPUTMESSAGE
          Symbolic constant for task instance action get input message.
static int GETOUTPUTMESSAGE
          Symbolic constant for task instance action get output message.
static int GETROLEINFO
          Symbolic constant for task instance action to retrieve role related information.
static int GETTASK
          Symbolic constant for task instance action get task.
static int GETTASKINSTANCE
          Deprecated. Use GETTASK.
static int GETUISETTINGS
          Symbolic constant for task instance action get UI settings.
static int RESUME
          Symbolic constant for task instance action resume task.
static int SETCUSTOMPROPERTY
          Symbolic constant for task instance action set custom properties.
static int SETFAULTMESSAGE
          Symbolic constant for task instance action set fault message.
static int SETOUTPUTMESSAGE
          Symbolic constant for task instance action set output message.
static int STARTTASK
          Symbolic constant for task instance action start task.
static int SUSPEND
          Symbolic constant for task instance action suspend task.
static int TERMINATE
          Symbolic constant for task instance action terminate task.
static int TRANSFERWORKITEM
          Symbolic constant for task instance action transfer work item.
static int UPDATE
          Symbolic constant for task instance action update task.
static int UPDATEINACTIVETASK
          Symbolic constant for task instance action update inactive task.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

CLAIM

public static final int CLAIM
Symbolic constant for task instance action claim.

Since:
5.1
See Also:
Constant Field Values

COMPLETE

public static final int COMPLETE
Symbolic constant for task instance action complete.

Since:
5.1
See Also:
Constant Field Values

CANCELCLAIM

public static final int CANCELCLAIM
Symbolic constant for task instance action cancel claim.

Since:
5.1
See Also:
Constant Field Values

SETOUTPUTMESSAGE

public static final int SETOUTPUTMESSAGE
Symbolic constant for task instance action set output message.

Since:
5.1
See Also:
Constant Field Values

SETCUSTOMPROPERTY

public static final int SETCUSTOMPROPERTY
Symbolic constant for task instance action set custom properties.

Since:
5.1
See Also:
Constant Field Values

GETOUTPUTMESSAGE

public static final int GETOUTPUTMESSAGE
Symbolic constant for task instance action get output message.

Since:
5.1
See Also:
Constant Field Values

GETINPUTMESSAGE

public static final int GETINPUTMESSAGE
Symbolic constant for task instance action get input message.

Since:
5.1
See Also:
Constant Field Values

GETFAULTMESSAGE

public static final int GETFAULTMESSAGE
Symbolic constant for task instance action get fault message.

Since:
5.1
See Also:
Constant Field Values

GETCUSTOMPROPERTY

public static final int GETCUSTOMPROPERTY
Symbolic constant for task instance action get custom property. Includes getCustomPropertyNames() and getCustomProperties().

Since:
5.1
See Also:
Constant Field Values

GETTASKINSTANCE

public static final int GETTASKINSTANCE
Deprecated. Use GETTASK.

Symbolic constant for task instance action get task instance.

Since:
5.1
See Also:
Constant Field Values

GETUISETTINGS

public static final int GETUISETTINGS
Symbolic constant for task instance action get UI settings.

Since:
5.1
See Also:
Constant Field Values

SETFAULTMESSAGE

public static final int SETFAULTMESSAGE
Symbolic constant for task instance action set fault message.

Since:
5.1
See Also:
Constant Field Values

CREATEMESSAGE

public static final int CREATEMESSAGE
Deprecated. Use CREATEINPUTMESSAGE, CREATEOUTPUTMESSAGE, CREATEFAULTMESSAGE.

Symbolic constant for task instance action create message.

Since:
5.1
See Also:
Constant Field Values

CREATEWORKITEM

public static final int CREATEWORKITEM
Symbolic constant for task instance action create work item.

Since:
5.1
See Also:
Constant Field Values

DELETEWORKITEM

public static final int DELETEWORKITEM
Symbolic constant for task instance action delete work item.

Since:
5.1
See Also:
Constant Field Values

TRANSFERWORKITEM

public static final int TRANSFERWORKITEM
Symbolic constant for task instance action transfer work item.

Since:
5.1
See Also:
Constant Field Values

GETFAULTNAMES

public static final int GETFAULTNAMES
Symbolic constant for task instance action get fault names.

Since:
5.1
See Also:
Constant Field Values

CALLTASK

public static final int CALLTASK
Symbolic constant for task instance action call task.

Since:
6.0
See Also:
Constant Field Values

CREATEFAULTMESSAGE

public static final int CREATEFAULTMESSAGE
Symbolic constant for task instance action create fault message.

Since:
6.0
See Also:
Constant Field Values

CREATEINPUTMESSAGE

public static final int CREATEINPUTMESSAGE
Symbolic constant for task instance action create input message.

Since:
6.0
See Also:
Constant Field Values

CREATEOUTPUTMESSAGE

public static final int CREATEOUTPUTMESSAGE
Symbolic constant for task instance action create output message.

Since:
6.0
See Also:
Constant Field Values

DELETE

public static final int DELETE
Symbolic constant for task instance action delete task.

Since:
6.0
See Also:
Constant Field Values

GETDOCUMENTATION

public static final int GETDOCUMENTATION
Symbolic constant for task instance action get documentation.

Since:
6.0
See Also:
Constant Field Values

GETTASK

public static final int GETTASK
Symbolic constant for task instance action get task.

Since:
6.0
See Also:
Constant Field Values

STARTTASK

public static final int STARTTASK
Symbolic constant for task instance action start task.

Since:
6.0
See Also:
Constant Field Values

RESUME

public static final int RESUME
Symbolic constant for task instance action resume task.

Since:
6.0
See Also:
Constant Field Values

SUSPEND

public static final int SUSPEND
Symbolic constant for task instance action suspend task.

Since:
6.0
See Also:
Constant Field Values

TERMINATE

public static final int TERMINATE
Symbolic constant for task instance action terminate task.

Since:
6.0
See Also:
Constant Field Values

UPDATE

public static final int UPDATE
Symbolic constant for task instance action update task.

Since:
6.0
See Also:
Constant Field Values

GETROLEINFO

public 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:
Constant Field Values

UPDATEINACTIVETASK

public static final int UPDATEINACTIVETASK
Symbolic constant for task instance action update inactive task.

Since:
6.0
See Also:
Constant Field Values