|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Accesses the properties of an escalation instance.
Escalations are activated at a certain task state and escalate when the escalation period times out before the associated task has reached an expected state. If escalated, the defined action is performed.
Field Summary | |
---|---|
static int |
ACTION_CREATE_EVENT
Creates and publishes an event. |
static int |
ACTION_CREATE_WORK_ITEM
Creates a work item for each escalation receiver. |
static int |
ACTION_SEND_EMAIL
Sends an e-mail to each escalation receiver. |
static int |
ACTIVATION_STATE_CLAIMED
States that the task has been claimed. |
static int |
ACTIVATION_STATE_READY
States that the human task is ready to be claimed |
static int |
ACTIVATION_STATE_RUNNING
States that the machine task is started and running |
static int |
ACTIVATION_STATE_WAITING_FOR_SUBTASK
States that the task is waiting for the completion of sub-tasks. |
static int |
AT_LEAST_EXPECTED_STATE_CLAIMED
States that the task must have been claimed. |
static int |
AT_LEAST_EXPECTED_STATE_ENDED
States that the task must be in a final state (FINISHED, FAILED, TERMINATED or EXPIRED). |
static int |
AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
States that all subtasks of the task must be completed. |
static java.lang.String |
COPYRIGHT
|
static int |
INCREASE_PRIORITY_NO
The task priority will not be increased. |
static int |
INCREASE_PRIORITY_ONCE
The task priority will be increased once by 1. |
static int |
INCREASE_PRIORITY_REPEATED
The task priority will be increased by 1 each time the escalation repeats. |
static int |
STATE_ESCALATED
States that the expected task state has not been reached in time. |
static int |
STATE_INACTIVE
States that the escalation (timer) has not yet been started. |
static int |
STATE_SUBTASKS_COMPLETED
States that all subtasks have been completed. |
static int |
STATE_SUPERFLUOUS
States that the expected task state has been reached in time. |
static int |
STATE_WAITING
States that the escalation (timer) has been started and waits for timeout. |
Method Summary | |
---|---|
int |
getAction()
Returns the action that is executed when the escalation occurs or that is executed when the escalation is repeated. |
int |
getActivationState()
Returns the task state when this escalation was activated. |
java.util.Calendar |
getActivationTime()
Returns the time when the escalation instance was activated. |
int |
getAtLeastExpectedState()
Returns the state of the associated task, that, if not reached when the escalation period runs out, triggers the escalation of this escalation instance. |
com.ibm.bpe.api.OID |
getContainmentContextID()
Returns the ID of the context the escalation belongs to. |
java.lang.String |
getDescription(java.util.Locale arg0)
Returns the description in the specified locale. |
java.lang.String |
getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale. |
java.lang.String |
getDurationUntilEscalated()
Returns the duration until this escalation is escalated or had been escalated. |
java.lang.String |
getDurationUntilRepeated()
Returns the duration that is spent until the escalation is repeated provided that the at least expected task state is still not reached. |
ESTID |
getEscalationTemplateID()
Returns the object ID of the associated escalation template. |
ESIID |
getFirstEscalationID()
Returns the object ID of the first escalation in the escalation chain. |
ESIID |
getID()
Returns the object identifier. |
java.util.List |
getLocalesOfDescriptions()
Returns the locales of all descriptions. |
java.util.List |
getLocalesOfDisplayNames()
Returns the locales of all display names. |
java.lang.String |
getName()
Returns the name of the escalation instance. |
ESIID |
getNextEscalationID()
Returns the object ID of the next escalation in the escalation chain. |
ESIID |
getPreviousEscalationID()
Returns the object ID of the previous escalation in the escalation chain. |
int |
getPriorityIncrease()
States how this escalation increases the priority of the associated task. |
int |
getState()
Returns the state of the escalation instance. |
TKIID |
getTaskInstanceID()
Returns the object ID of the associated task instance. |
void |
setName(java.lang.String name)
Sets the name of the escalation instance. |
Field Detail |
public static final java.lang.String COPYRIGHT
public static final int ACTIVATION_STATE_RUNNING
public static final int ACTIVATION_STATE_CLAIMED
public static final int ACTIVATION_STATE_WAITING_FOR_SUBTASK
public static final int ACTIVATION_STATE_READY
public static final int AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
public static final int AT_LEAST_EXPECTED_STATE_ENDED
public static final int AT_LEAST_EXPECTED_STATE_CLAIMED
public static final int ACTION_CREATE_WORK_ITEM
public static final int ACTION_SEND_EMAIL
public static final int ACTION_CREATE_EVENT
public static final int INCREASE_PRIORITY_NO
public static final int INCREASE_PRIORITY_ONCE
public static final int INCREASE_PRIORITY_REPEATED
public static final int STATE_SUBTASKS_COMPLETED
public static final int STATE_INACTIVE
public static final int STATE_SUPERFLUOUS
public static final int STATE_ESCALATED
public static final int STATE_WAITING
Method Detail |
public ESIID getID()
public int getActivationState()
Possible activation states are: STATE_READY and STATE_CLAIMED for tasks that are to be executed by humans and STATE_RUNNING for tasks that are executed by a machine.
public java.util.Calendar getActivationTime()
public java.lang.String getDescription(java.util.Locale arg0)
This method returns the description in the default locale when a description in the specified locale is not found. If no locale is specified, the description in the default locale is returned or any available description, if there is only a single description. References to variable members specified as %variableName.memberName% are resolved.
arg0
- The locale for which the description is to be provided.public java.util.List getLocalesOfDescriptions()
public java.lang.String getDisplayName(java.util.Locale arg0)
This method returns the display name in the default locale when a display name in the specified locale is not found. If no locale is specified, the display name in the default locale is returned or any available display name, if there is only a single display name.
arg0
- The locale for which the display name is to be provided.public java.util.List getLocalesOfDisplayNames()
public java.lang.String getDurationUntilEscalated()
public int getAtLeastExpectedState()
Possible states are AT_LEAST_EXPECTED_STATE_CLAIMED, AT_LEAST_EXPECTED_STATE_ENDED, AND AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED.
public java.lang.String getDurationUntilRepeated()
public int getAction()
Possible actions are ACTION_CREATE_WORK_ITEM, ACTION_SEND_EMAIL, and ACTION_CREATE_EVENT.
public int getPriorityIncrease()
Possible values are NO, ONCE, and REPEATED.
public java.lang.String getName()
public com.ibm.bpe.api.OID getContainmentContextID()
public ESIID getFirstEscalationID()
public ESIID getPreviousEscalationID()
public ESIID getNextEscalationID()
public ESTID getEscalationTemplateID()
public TKIID getTaskInstanceID()
public int getState()
Returns either STATE_INACTIVE, STATE_WAITING, STATE_ESCALATED, STATE_SUPERFLUOUS, STATE_SUBTASKS_COMPLETED.
public void setName(java.lang.String name)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |