|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Escalation
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 to-do aka participating task or collaboration aka human task is ready to be claimed |
static int |
ACTIVATION_STATE_RUNNING
States that the invocation aka originating task is started and running |
static int |
ACTIVATION_STATE_WAITING_FOR_SUBTASK
States that the task is waiting for the completion of subtasks. |
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_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. |
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 value that is used to calculate the escalation time when the activation state is reached - refer to getEscalationTime . |
java.lang.String |
getDurationUntilRepeated()
Returns the value that is used to calculate the next escalation time once the task is escalated - refer to getEscalationTime . |
ESTID |
getEscalationTemplateID()
Returns the object ID of the associated escalation template. |
java.util.Calendar |
getEscalationTime()
Returns the time when the escalation will fire or null when no escalation timer is running. |
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. |
boolean |
isDurationUntilEscalatedUpdateable()
Signals whether the duration until escalation property can be changed for the kind and current state of the object. |
boolean |
isDurationUntilRepeatedUpdateable()
Signals whether the duration until repeats property can be changed for the kind and current state of the object. |
boolean |
isEscalationTimeUpdateable()
Signals whether the escalation time property can be changed for the kind and current state of the object. |
boolean |
isNameUpdateable()
Signals whether the name property can be changed for the kind and current state of the object. |
void |
setDurationUntilEscalated(java.lang.String durationUntilEscalation)
Sets the duration that passes until the escalation fires. |
void |
setDurationUntilRepeated(java.lang.String durationUntilRepeats)
Sets the duration that passes until the escalation fires next. |
void |
setEscalationTime(java.util.Calendar escalationTime)
Sets the time when the escalation will fire. |
void |
setName(java.lang.String name)
Sets the name of the escalation instance. |
Field Detail |
---|
static final java.lang.String COPYRIGHT
static final int ACTIVATION_STATE_CLAIMED
static final int ACTIVATION_STATE_WAITING_FOR_SUBTASK
static final int ACTIVATION_STATE_RUNNING
static final int ACTIVATION_STATE_READY
static final int AT_LEAST_EXPECTED_STATE_ENDED
static final int AT_LEAST_EXPECTED_STATE_CLAIMED
static final int AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
static final int ACTION_CREATE_EVENT
static final int ACTION_CREATE_WORK_ITEM
static final int ACTION_SEND_EMAIL
static final int INCREASE_PRIORITY_REPEATED
static final int INCREASE_PRIORITY_ONCE
static final int INCREASE_PRIORITY_NO
static final int STATE_ESCALATED
static final int STATE_INACTIVE
static final int STATE_SUPERFLUOUS
static final int STATE_WAITING
Method Detail |
---|
ESIID getID()
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.
java.util.Calendar getActivationTime()
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.java.util.List getLocalesOfDescriptions()
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.java.util.List getLocalesOfDisplayNames()
java.lang.String getDurationUntilEscalated()
getEscalationTime
.
This property is a WebSphere Application Server calendar expression
according to the calendar referenced by its name and JNDI name
on the associated task.
TimerSpecification.DURATION_NOT_USED
means that the escalation time is set explicitely - see
setExcalationTime
.
If the duration is not set, null is returned.
To update the duration see the
setDurationUntilEscalated
method.
int getAtLeastExpectedState()
Possible states are AT_LEAST_EXPECTED_STATE_CLAIMED, AT_LEAST_EXPECTED_STATE_ENDED, AND AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED.
java.lang.String getDurationUntilRepeated()
getEscalationTime
.
This property is a WebSphere Application Server calendar expression according to the calendar referenced by its name and JNDI name on the associated task. If the duration is not set, null is returned.
To update the duration see the
setDurationUntilRepeated
method.
int getAction()
Possible actions are ACTION_CREATE_WORK_ITEM, ACTION_SEND_EMAIL, and ACTION_CREATE_EVENT.
int getPriorityIncrease()
Possible values are INCREASE_PRIORITY_NO, INCREASE_PRIORITY_ONCE, and INCREASE_PRIORITY_REPEATED.
java.lang.String getName()
OID getContainmentContextID()
ESIID getFirstEscalationID()
ESIID getPreviousEscalationID()
ESIID getNextEscalationID()
ESTID getEscalationTemplateID()
TKIID getTaskInstanceID()
int getState()
Returns either STATE_INACTIVE, STATE_WAITING, STATE_ESCALATED, STATE_SUPERFLUOUS.
java.util.Calendar getEscalationTime()
Escalations are fired when the escalation period times out before the associated task reached a certain (at least expected) state.
void setName(java.lang.String name)
name
- The new name of the escalation instance.boolean isNameUpdateable()
void setEscalationTime(java.util.Calendar escalationTime)
TimerSpecification.DURATION_NOT_USED
.
- see getDurationUntilEscalated
.
If the escalation is in state ESCALATED, the current repetition timer is canceled and a new one is created. The duration until repeated remains unchanged.
escalationTime
- The time when the escalation instance will fire.
Note that setting the escalation time to null is not accepted by the update method,
that is, an exception will be thrown,boolean isEscalationTimeUpdateable()
void setDurationUntilEscalated(java.lang.String durationUntilEscalation)
This property is a WebSphere Application Server calendar expression according to the calendar referenced by its name and JNDI name on the associated task.
durationUntilEscalation
- The duration that should pass until the escalation instance fires.
Note that setting the duration to
TimerSpecification.DURATION_IMMEDIATE
is not accepted by the update method, that is, an exception will be thrown,boolean isDurationUntilEscalatedUpdateable()
void setDurationUntilRepeated(java.lang.String durationUntilRepeats)
TimerSpecification.DURATION_INFINITE
is specified and the escalation is escalated, the escalation will not repeat.
If TimerSpecification.DURATION_IMMEDIATE
is specified and the escalation is escalated, the
escalation will repeat immediately.
This property is a WebSphere Application Server calendar expression according to the calendar referenced by its name and JNDI name on the associated task.
durationUntilRepeats
- The duration that should pass until the escalation instance fires next.boolean isDurationUntilRepeatedUpdateable()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |