com.ibm.task.api
Interface EscalationTemplate
- public interface EscalationTemplate
- extends java.io.Serializable
An escalation template contains the specification of escalations. 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
Modifier and Type | Field and Description |
---|---|
|
ACTION_CREATE_EVENT
Creates and publishes an event.
|
|
ACTION_CREATE_WORK_ITEM
Creates a work item for each escalation receiver.
|
|
ACTION_SEND_EMAIL
Sends an e-mail to each escalation receiver.
|
|
ACTIVATION_STATE_CLAIMED
States that the task has been claimed.
|
|
ACTIVATION_STATE_READY
States that the to-do aka participating task or collaboration aka human task is ready to be claimed
|
|
ACTIVATION_STATE_RUNNING
States that the invocation aka originating task is started and running
|
|
ACTIVATION_STATE_WAITING_FOR_SUBTASK
States that the task is waiting
for the completion of subtasks.
|
|
AT_LEAST_EXPECTED_STATE_CLAIMED
States that the task must have been claimed.
|
|
AT_LEAST_EXPECTED_STATE_ENDED
States that the task must be in a final state (FINISHED, FAILED, TERMINATED, or EXPIRED).
|
|
AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
States that all subtasks of the task must be completed.
|
|
COPYRIGHT
|
|
INCREASE_PRIORITY_NO
The task priority will not be increased.
|
|
INCREASE_PRIORITY_ONCE
The task priority will be increased once by 1.
|
|
INCREASE_PRIORITY_REPEATED
The task priority will be increased by 1 each time the escalation repeats.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getAction()
Returns the action that is executed when an escalation occurs.
|
|
getActivationState()
Returns the task state that triggers creation of escalations derived from this template.
|
|
getAtLeastExpectedState()
Returns the state of tasks associated to escalations derived from this template that,
if not reached when the escalation period runs out,
trigger escalations.
|
getContainmentContextID()
Returns the ID of the context the escalation template belongs to.
|
|
|
getDescription(java.util.Locale arg0)
Returns the description in the specified locale.
|
|
getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale.
|
|
getDurationUntilEscalated()
Returns the duration until escalations derived from this template are escalated.
|
|
getDurationUntilRepeated()
Returns the duration that is spent until escalations derived from this template are
repeated.
|
getFirstEscalationTemplateID()
Returns the object ID of the first escalation template in an escalation template chain.
|
|
getID()
Returns the object identifier.
|
|
|
getLocalesOfDescriptions()
Returns the locales of all descriptions.
|
|
getLocalesOfDisplayNames()
Returns the locales of all display names.
|
|
getName()
Returns the name of the escalation template.
|
getNextEscalationTemplateID()
Returns the object ID of the next escalation template in an escalation template chain.
|
|
getPreviousEscalationTemplateID()
Returns the object ID of the previous escalation template in an escalation template chain.
|
|
|
getPriorityIncrease()
States how escalations derived from this template increase
the priority of associated tasks when they are escalated.
|
getTaskTemplateID()
Returns the object ID of the associated task template.
|
|
|
isNameUpdateable()
Signals whether the name property can be changed for the kind and current state of the object.
|
|
setName(java.lang.String name)
For future use.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
ACTIVATION_STATE_CLAIMED
- static final int ACTIVATION_STATE_CLAIMED
ACTIVATION_STATE_WAITING_FOR_SUBTASK
- static final int ACTIVATION_STATE_WAITING_FOR_SUBTASK
ACTIVATION_STATE_RUNNING
- static final int ACTIVATION_STATE_RUNNING
ACTIVATION_STATE_READY
- static final int ACTIVATION_STATE_READY
AT_LEAST_EXPECTED_STATE_ENDED
- static final int AT_LEAST_EXPECTED_STATE_ENDED
AT_LEAST_EXPECTED_STATE_CLAIMED
- static final int AT_LEAST_EXPECTED_STATE_CLAIMED
AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
- static final int AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
ACTION_CREATE_EVENT
- static final int ACTION_CREATE_EVENT
ACTION_CREATE_WORK_ITEM
- static final int ACTION_CREATE_WORK_ITEM
ACTION_SEND_EMAIL
- static final int ACTION_SEND_EMAIL
INCREASE_PRIORITY_REPEATED
- static final int INCREASE_PRIORITY_REPEATED
INCREASE_PRIORITY_ONCE
- static final int INCREASE_PRIORITY_ONCE
INCREASE_PRIORITY_NO
- static final int INCREASE_PRIORITY_NO
Method Detail
getID
- ESTID getID()
getDescription
- java.lang.String getDescription( java.util.Locale arg0)
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. getLocalesOfDescriptions
- java.util.List getLocalesOfDescriptions( )
getDisplayName
- java.lang.String getDisplayName( java.util.Locale arg0)
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. getLocalesOfDisplayNames
- java.util.List getLocalesOfDisplayNames( )
getDurationUntilEscalated
- java.lang.String getDurationUntilEscalated( )
getActivationState
- 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.
getAtLeastExpectedState
- int getAtLeastExpectedState()
Possible states are AT_LEAST_EXPECTED_STATE_CLAIMED, AT_LEAST_EXPECTED_STATE_ENDED, AND AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED.
getDurationUntilRepeated
- java.lang.String getDurationUntilRepeated( )
getAction
- int getAction()
Possible actions are ACTION_CREATE_WORK_ITEM, ACTION_SEND_EMAIL, and ACTION_CREATE_EVENT.
getPriorityIncrease
- int getPriorityIncrease()
Possible values are INCREASE_PRIORITY_NO, INCREASE_PRIORITY_ONCE, and INCREASE_PRIORITY_REPEATED.
getName
- java.lang.String getName()
getContainmentContextID
- OID getContainmentContextID()
getFirstEscalationTemplateID
- ESTID getFirstEscalationTemplateID( )
getPreviousEscalationTemplateID
- ESTID getPreviousEscalationTemplateID( )
getNextEscalationTemplateID
- ESTID getNextEscalationTemplateID( )
getTaskTemplateID
- TKTID getTaskTemplateID()
setName
- void setName(java.lang.String name)
isNameUpdateable
- boolean isNameUpdateable()