com.ibm.task.api

Interface EscalationTemplate

All Superinterfaces:
java.io.Serializable

  1. public interface EscalationTemplate
  2. extends java.io.Serializable
Accesses the properties of an escalation template.

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.

Since:
6.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
ACTION_CREATE_EVENT
Creates and publishes an event.
  1. static
  2. int
ACTION_CREATE_WORK_ITEM
Creates a work item for each escalation receiver.
  1. static
  2. int
ACTION_SEND_EMAIL
Sends an e-mail to each escalation receiver.
  1. static
  2. int
ACTIVATION_STATE_CLAIMED
States that the task has been claimed.
  1. static
  2. int
ACTIVATION_STATE_READY
States that the to-do aka participating task or collaboration aka human task is ready to be claimed
  1. static
  2. int
ACTIVATION_STATE_RUNNING
States that the invocation aka originating task is started and running
  1. static
  2. int
ACTIVATION_STATE_WAITING_FOR_SUBTASK
States that the task is waiting for the completion of subtasks.
  1. static
  2. int
AT_LEAST_EXPECTED_STATE_CLAIMED
States that the task must have been claimed.
  1. static
  2. int
AT_LEAST_EXPECTED_STATE_ENDED
States that the task must be in a final state (FINISHED, FAILED, TERMINATED, or EXPIRED).
  1. static
  2. int
AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
States that all subtasks of the task must be completed.
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
INCREASE_PRIORITY_NO
The task priority will not be increased.
  1. static
  2. int
INCREASE_PRIORITY_ONCE
The task priority will be increased once by 1.
  1. static
  2. int
INCREASE_PRIORITY_REPEATED
The task priority will be increased by 1 each time the escalation repeats.

Method Summary

Modifier and Type Method and Description
  1. int
getAction()
Returns the action that is executed when an escalation occurs.
  1. int
getActivationState()
Returns the task state that triggers creation of escalations derived from this template.
  1. int
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.
  1. OID
getContainmentContextID()
Returns the ID of the context the escalation template belongs to.
  1. java.lang.String
getDescription(java.util.Locale arg0)
Returns the description in the specified locale.
  1. java.lang.String
getDisplayName(java.util.Locale arg0)
Returns the display name in the specified locale.
  1. java.lang.String
getDurationUntilEscalated()
Returns the duration until escalations derived from this template are escalated.
  1. java.lang.String
getDurationUntilRepeated()
Returns the duration that is spent until escalations derived from this template are repeated.
  1. ESTID
getFirstEscalationTemplateID()
Returns the object ID of the first escalation template in an escalation template chain.
  1. ESTID
getID()
Returns the object identifier.
  1. java.util.List
getLocalesOfDescriptions()
Returns the locales of all descriptions.
  1. java.util.List
getLocalesOfDisplayNames()
Returns the locales of all display names.
  1. java.lang.String
getName()
Returns the name of the escalation template.
  1. ESTID
getNextEscalationTemplateID()
Returns the object ID of the next escalation template in an escalation template chain.
  1. ESTID
getPreviousEscalationTemplateID()
Returns the object ID of the previous escalation template in an escalation template chain.
  1. int
getPriorityIncrease()
States how escalations derived from this template increase the priority of associated tasks when they are escalated.
  1. TKTID
getTaskTemplateID()
Returns the object ID of the associated task template.
  1. boolean
isNameUpdateable()
Signals whether the name property can be changed for the kind and current state of the object.
  1. void
setName(java.lang.String name)
For future use.

Field Detail

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

ACTIVATION_STATE_CLAIMED

  1. static final int ACTIVATION_STATE_CLAIMED
States that the task has been claimed.
See Also:

ACTIVATION_STATE_WAITING_FOR_SUBTASK

  1. static final int ACTIVATION_STATE_WAITING_FOR_SUBTASK
States that the task is waiting for the completion of subtasks. Note: the states (values) must correspond to the values in TaskInstance.
See Also:

ACTIVATION_STATE_RUNNING

  1. static final int ACTIVATION_STATE_RUNNING
States that the invocation aka originating task is started and running
See Also:

ACTIVATION_STATE_READY

  1. static final int ACTIVATION_STATE_READY
States that the to-do aka participating task or collaboration aka human task is ready to be claimed
See Also:

AT_LEAST_EXPECTED_STATE_ENDED

  1. static final int AT_LEAST_EXPECTED_STATE_ENDED
States that the task must be in a final state (FINISHED, FAILED, TERMINATED, or EXPIRED).
See Also:

AT_LEAST_EXPECTED_STATE_CLAIMED

  1. static final int AT_LEAST_EXPECTED_STATE_CLAIMED
States that the task must have been claimed.
See Also:

AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED

  1. static final int AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
States that all subtasks of the task must be completed.
See Also:

ACTION_CREATE_EVENT

  1. static final int ACTION_CREATE_EVENT
Creates and publishes an event.
See Also:

ACTION_CREATE_WORK_ITEM

  1. static final int ACTION_CREATE_WORK_ITEM
Creates a work item for each escalation receiver.
See Also:

ACTION_SEND_EMAIL

  1. static final int ACTION_SEND_EMAIL
Sends an e-mail to each escalation receiver.
See Also:

INCREASE_PRIORITY_REPEATED

  1. static final int INCREASE_PRIORITY_REPEATED
The task priority will be increased by 1 each time the escalation repeats.
See Also:

INCREASE_PRIORITY_ONCE

  1. static final int INCREASE_PRIORITY_ONCE
The task priority will be increased once by 1.
See Also:

INCREASE_PRIORITY_NO

  1. static final int INCREASE_PRIORITY_NO
The task priority will not be increased.
See Also:

Method Detail

getID

  1. ESTID getID()
Returns the object identifier.

getDescription

  1. java.lang.String getDescription( java.util.Locale arg0)
Returns the description in the specified locale. 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.

Parameters:
arg0 - The locale for which the description is to be provided.

getLocalesOfDescriptions

  1. java.util.List getLocalesOfDescriptions( )
Returns the locales of all descriptions. Returns an empty list when there are no descriptions.

getDisplayName

  1. java.lang.String getDisplayName( java.util.Locale arg0)
Returns the display name in the specified locale. 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.

Parameters:
arg0 - The locale for which the display name is to be provided.

getLocalesOfDisplayNames

  1. java.util.List getLocalesOfDisplayNames( )
Returns the locales of all display names. Returns an empty list when there are no display names.

getDurationUntilEscalated

  1. java.lang.String getDurationUntilEscalated( )
Returns the duration until escalations derived from this template are escalated. Escalations are escalated when the escalation period times out before the associated task reached a certain (at least expected) state. If not set, null is returned.

getActivationState

  1. int getActivationState()
Returns the task state that triggers creation of escalations derived from this template.

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

  1. int 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.

Possible states are AT_LEAST_EXPECTED_STATE_CLAIMED, AT_LEAST_EXPECTED_STATE_ENDED, AND AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED.


getDurationUntilRepeated

  1. java.lang.String getDurationUntilRepeated( )
Returns the duration that is spent until escalations derived from this template are repeated. Note that escalations are only repeated when the expected task state is still not reached. If not set, null is returned.

getAction

  1. int getAction()
Returns the action that is executed when an escalation occurs.

Possible actions are ACTION_CREATE_WORK_ITEM, ACTION_SEND_EMAIL, and ACTION_CREATE_EVENT.


getPriorityIncrease

  1. int getPriorityIncrease()
States how escalations derived from this template increase the priority of associated tasks when they are escalated.

Possible values are INCREASE_PRIORITY_NO, INCREASE_PRIORITY_ONCE, and INCREASE_PRIORITY_REPEATED.


getName

  1. java.lang.String getName()
Returns the name of the escalation template.

getContainmentContextID

  1. OID getContainmentContextID()
Returns the ID of the context the escalation template belongs to. This ID is used for escalation template and instance deletion. In other words, when the context is deleted, the escalation template and derived instances are also deleted.

getFirstEscalationTemplateID

  1. ESTID getFirstEscalationTemplateID( )
Returns the object ID of the first escalation template in an escalation template chain.

getPreviousEscalationTemplateID

  1. ESTID getPreviousEscalationTemplateID( )
Returns the object ID of the previous escalation template in an escalation template chain. Returns null if there is no previous escalation template.

getNextEscalationTemplateID

  1. ESTID getNextEscalationTemplateID( )
Returns the object ID of the next escalation template in an escalation template chain. Returns null if there is no previous escalation template.

getTaskTemplateID

  1. TKTID getTaskTemplateID()
Returns the object ID of the associated task template.

setName

  1. void setName(java.lang.String name)
For future use.

isNameUpdateable

  1. boolean isNameUpdateable()
Signals whether the name property can be changed for the kind and current state of the object.