com.ibm.task.api

Interface Escalation

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    EscalationBean


    public interface Escalation
    extends java.io.Serializable
    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.

    Since:
    6.0
    • Field Detail

      • ACTIVATION_STATE_CLAIMED

        static final int ACTIVATION_STATE_CLAIMED
        States that the task has been claimed.
        See Also:
        Constant Field Values
      • ACTIVATION_STATE_WAITING_FOR_SUBTASK

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

        static final int ACTIVATION_STATE_RUNNING
        States that the invocation aka originating task is started and running
        See Also:
        Constant Field Values
      • ACTIVATION_STATE_READY

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

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

        static final int AT_LEAST_EXPECTED_STATE_CLAIMED
        States that the task must have been claimed.
        See Also:
        Constant Field Values
      • AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED

        static final int AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED
        States that all subtasks of the task must be completed.
        See Also:
        Constant Field Values
      • ACTION_CREATE_EVENT

        static final int ACTION_CREATE_EVENT
        Creates and publishes an event.
        See Also:
        Constant Field Values
      • ACTION_CREATE_WORK_ITEM

        static final int ACTION_CREATE_WORK_ITEM
        Creates a work item for each escalation receiver.
        See Also:
        Constant Field Values
      • ACTION_SEND_EMAIL

        static final int ACTION_SEND_EMAIL
        Sends an e-mail to each escalation receiver.
        See Also:
        Constant Field Values
      • INCREASE_PRIORITY_REPEATED

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

        static final int INCREASE_PRIORITY_ONCE
        The task priority will be increased once by 1.
        See Also:
        Constant Field Values
      • INCREASE_PRIORITY_NO

        static final int INCREASE_PRIORITY_NO
        The task priority will not be increased.
        See Also:
        Constant Field Values
      • STATE_ESCALATED

        static final int STATE_ESCALATED
        States that the expected task state has not been reached in time.
        See Also:
        Constant Field Values
      • STATE_INACTIVE

        static final int STATE_INACTIVE
        States that the escalation (timer) has not yet been started.
        See Also:
        Constant Field Values
      • STATE_SUPERFLUOUS

        static final int STATE_SUPERFLUOUS
        States that the expected task state has been reached in time.
        See Also:
        Constant Field Values
      • STATE_WAITING

        static final int STATE_WAITING
        States that the escalation (timer) has been started and waits for timeout.
        See Also:
        Constant Field Values
    • Method Detail

      • getID

        ESIID getID()
        Returns the object identifier.
      • getActivationState

        int getActivationState()
        Returns the task state when this escalation was activated.

        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.

      • getActivationTime

        java.util.Calendar getActivationTime()
        Returns the time when the escalation instance was activated.
      • getDescription

        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

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

        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

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

        java.lang.String getDurationUntilEscalated()
        Returns the value that is used to calculate the escalation time when the activation state is reached - refer to 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.

      • getAtLeastExpectedState

        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.

        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()
        Returns the value that is used to calculate the next escalation time once the task is escalated - refer to 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.

      • getAction

        int getAction()
        Returns the action that is executed when the escalation occurs or that is executed when the escalation is repeated.

        Possible actions are ACTION_CREATE_WORK_ITEM, ACTION_SEND_EMAIL, and ACTION_CREATE_EVENT.

      • getPriorityIncrease

        int getPriorityIncrease()
        States how this escalation increases the priority of the associated task.

        Possible values are INCREASE_PRIORITY_NO, INCREASE_PRIORITY_ONCE, and INCREASE_PRIORITY_REPEATED.

      • getName

        java.lang.String getName()
        Returns the name of the escalation instance.
      • getContainmentContextID

        OID getContainmentContextID()
        Returns the ID of the context the escalation belongs to. This ID is used for escalation instance deletion. In other words, when the context is deleted, the escalation instance is also deleted.
      • getFirstEscalationID

        ESIID getFirstEscalationID()
        Returns the object ID of the first escalation in the escalation chain.
      • getPreviousEscalationID

        ESIID getPreviousEscalationID()
        Returns the object ID of the previous escalation in the escalation chain. Returns null if there is no previous escalation.
      • getNextEscalationID

        ESIID getNextEscalationID()
        Returns the object ID of the next escalation in the escalation chain. Returns null if there is no following escalation.
      • getEscalationTemplateID

        ESTID getEscalationTemplateID()
        Returns the object ID of the associated escalation template. Returns null if there is no associated escalation template.
      • getTaskInstanceID

        TKIID getTaskInstanceID()
        Returns the object ID of the associated task instance.
      • getState

        int getState()
        Returns the state of the escalation instance.

        Returns either STATE_INACTIVE, STATE_WAITING, STATE_ESCALATED, STATE_SUPERFLUOUS.

      • getEscalationTime

        java.util.Calendar getEscalationTime()
        Returns the time when the escalation will fire or null when no escalation timer is running.

        Escalations are fired when the escalation period times out before the associated task reached a certain (at least expected) state.

        Since:
        7.0.
      • setName

        void setName(java.lang.String name)
        Sets the name of the escalation instance.

        Parameters:
        name - The new name of the escalation instance.
        Since:
        7.0.
      • isNameUpdateable

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

        void setEscalationTime(java.util.Calendar escalationTime)
        Sets the time when the escalation will fire. If the escalation is in state WAITING, the existing timer is canceled and a new one is created. The duration until escalated is set to 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.

        Parameters:
        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,
        Since:
        7.0.
      • isEscalationTimeUpdateable

        boolean isEscalationTimeUpdateable()
        Signals whether the escalation time property can be changed for the kind and current state of the object.
      • setDurationUntilEscalated

        void setDurationUntilEscalated(java.lang.String durationUntilEscalation)
        Sets the duration that passes until the escalation fires. If the escalation is in state INACTIVE, this value is used to calculate the escalation time once the associated task reaches state WAITING. If the escalation is in state WAITING, the current timer is canceled and a new timer is set up according to the passed value.

        This property is a WebSphere Application Server calendar expression according to the calendar referenced by its name and JNDI name on the associated task.

        Parameters:
        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,
        Since:
        7.0.
      • isDurationUntilEscalatedUpdateable

        boolean isDurationUntilEscalatedUpdateable()
        Signals whether the duration until escalation property can be changed for the kind and current state of the object.
      • setDurationUntilRepeated

        void setDurationUntilRepeated(java.lang.String durationUntilRepeats)
        Sets the duration that passes until the escalation fires next. If the escalation is in state INACTIVE or WAITING, this value is used to calculate the escalation time once the associated task reaches state ESCALATED. If the escalation is in state ESCALATED, the current timer is canceled and a new one is set up according to the passed value. If 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.

        Parameters:
        durationUntilRepeats - The duration that should pass until the escalation instance fires next.
        Since:
        7.0.
      • isDurationUntilRepeatedUpdateable

        boolean isDurationUntilRepeatedUpdateable()
        Signals whether the duration until repeats property can be changed for the kind and current state of the object.
IBM Business Process ManagerTM
Release 8