com.ibm.task.clientmodel.bean

Class EscalationBean

  1. java.lang.Object
  2. extended bycom.ibm.task.clientmodel.bean.EscalationBean
All implemented interfaces:
Escalation, java.io.Serializable

  1. public class EscalationBean
  2. extends java.lang.Object
  3. implements Escalation

Accesses the properties of the original Escalation object and adds metadata for national language support and converters.

An EscalationBean object can be instantiated from a QueryResultSet object.
Only the following properties are loaded from the query result set:

If the property is not found in the query result set, the property remains empty. Accessing an empty property requires the bean to load the missing information from the server.

Use the static method getLabel(String, Locale) to retrieve the localized label for a property. Use the static method getConverter(String) to retrieve a converter for a property. The return value might be null because converters are optional.

See Also:
Escalation, QueryResultSet, Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
ACTION_PROPERTY
Use the property name to determine labels and converters for the action property .
  1. static
  2. java.lang.String
ACTIVATIONSTATE_PROPERTY
Use the property name to determine labels and converters for the activationState property.
  1. static
  2. java.lang.String
ACTIVATIONTIME_PROPERTY
Use the property name to determine labels and converters for the activationTime property.
  1. static
  2. java.lang.String
ATLEASTEXPECTEDSTATE_PROPERTY
Use the property name to determine labels and converters for the atLeastExpectedState property.
  1. static
  2. java.lang.String
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2011.
  1. static
  2. java.lang.String
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the description property.
  1. static
  2. java.lang.String
DURATIONUNTILESCALATED_PROPERTY
Use the property name to determine labels and converters for the durationUntilEscalated property.
  1. static
  2. java.lang.String
DURATIONUNTILREPEATED_PROPERTY
Use the property name to determine labels and converters for the durationUntilRepeated property.
  1. static
  2. java.lang.String
ESCALATION_RECEIVER_PROPERTY
Use the property name to determine labels and converters for the escalationReceiver property.
  1. static
  2. java.lang.String
FIRST_ESCALATION_ID_PROPERTY
Use the property name to determine labels and converters for the firstEscalationID property.
  1. static
  2. java.lang.String
NAME_PROPERTY
Use the property name to determine labels and converters for the name property.
  1. static
  2. java.lang.String
PRIORITY_INCREASE_PROPERTY
Use the property name to determine labels and converters for the priorityIncrease property.
  1. static
  2. java.lang.String
STATE_PROPERTY
Use the property name to determine labels and converters for the state property.
  1. static
  2. java.lang.String
TASK_OWNER_PROPERTY
Use the property name to determine labels and converters for the taskOwner property.
Fields inherited from interface com.ibm.task.api.Escalation
ACTION_CREATE_EVENT, ACTION_CREATE_WORK_ITEM, ACTION_SEND_EMAIL, ACTIVATION_STATE_CLAIMED, ACTIVATION_STATE_READY, ACTIVATION_STATE_RUNNING, ACTIVATION_STATE_WAITING_FOR_SUBTASK, AT_LEAST_EXPECTED_STATE_CLAIMED, AT_LEAST_EXPECTED_STATE_ENDED, AT_LEAST_EXPECTED_STATE_SUBTASKS_COMPLETED, INCREASE_PRIORITY_NO, INCREASE_PRIORITY_ONCE, INCREASE_PRIORITY_REPEATED, STATE_ESCALATED, STATE_INACTIVE, STATE_SUPERFLUOUS, STATE_WAITING

Constructor Summary

Modifier Constructor and Description
  1. (package private)
EscalationBean(Escalation esc,HTMConnection htmConnection)
Constructs a EscalationBean from an original Task object.
  1. protected
EscalationBean(ESIID id,HTMConnection htmConnection,java.util.Locale locale)
Constructs a EscalationBean from an escalation instance id.
  1. (package private)
EscalationBean(QueryResultSet resultSet,HTMConnection htmConnection)
Constructs a new EscalationBean from a QueryResultSet.

Method Summary

Modifier and Type Method and Description
  1. int
getAction()
Returns the action property.
  1. int
getActivationState()
Returns the activationState property.
  1. java.util.Calendar
getActivationTime()
Returns the activationTime property.
  1. int
getAtLeastExpectedState()
Returns the atLeastExpectedState property.
  1. OID
getContainmentContextID()
Returns the containmentContextID property.
  1. static
  2. SimpleConverter
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
  1. com.ibm.bpc.clientcore.util.LocalisedString
getDescription()
Returns the localised description.
  1. java.lang.String
getDescription(java.util.Locale locale)
Returns the description property.
  1. com.ibm.bpc.clientcore.util.LocalisedString
getDisplayName()
Returns the localised display name.
  1. java.lang.String
getDisplayName(java.util.Locale locale)
Returns the displayName property.
  1. java.lang.String
getDurationUntilEscalated()
Returns the durationUntilEscalated property.
  1. java.lang.String
getDurationUntilRepeated()
Returns the durationUntilRepeated property.
  1. java.lang.String
getEscalationReceiver()
Returns the escalationReceiver property.
  1. ESTID
getEscalationTemplateID()
Returns the escalationTemplateID property.
  1. java.util.Calendar
getEscalationTime()
Returns the escalationTime property.
  1. ESIID
getFirstEscalationID()
Returns the firstEscalationID property.
  1. ESIID
getID()
Returns the ID property.
  1. static
  2. java.lang.String
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property
  1. static
  2. java.lang.String
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label of a property from the resource bundle.
  1. java.util.List
getLocalesOfDescriptions()
Returns the localesOfDescriptions property.
  1. java.util.List
getLocalesOfDisplayNames()
Returns the localesOfDisplayNames property.
  1. java.lang.String
getName()
Returns the name property.
  1. ESIID
getNextEscalationID()
Returns the nextEscalationID property.
  1. ESIID
getPreviousEscalationID()
Returns the previousEscalationID property.
  1. int
getPriorityIncrease()
Returns the priorityIncrease property.
  1. int
getState()
Returns the state property.
  1. TKIID
getTaskInstanceID()
Returns the taskInstanceID property.
  1. java.lang.String
getTaskName()
Returns the taskName property.
  1. java.lang.String
getTaskOwner()
Returns the taskOwner property.
  1. TKTID
getTaskTemplateID()
Returns the property tktid.
  1. boolean
isDurationUntilEscalatedUpdateable()
Signals whether the duration until escalation property can be changed for the kind and current state of the object.
  1. boolean
isDurationUntilRepeatedUpdateable()
Signals whether the duration until repeats property can be changed for the kind and current state of the object.
  1. boolean
isEscalationTimeUpdateable()
Signals whether the escalation time property can be changed for the kind and current state of the object.
  1. boolean
isNameUpdateable()
Signals whether the name property can be changed for the kind and current state of the object.
  1. static
  2. boolean
isValid(java.lang.String propertyName)
Checks whether the property is valid.
  1. void
setDurationUntilEscalated(java.lang.String durationUntilEscalation)
Sets the durationUntilRepeated property.
  1. void
setDurationUntilRepeated(java.lang.String durationUntilRepeats)
Sets the durationUntilRepeated property.
  1. void
setEscalationTime(java.util.Calendar escalationTime)
Sets the name property.
  1. void
setName(java.lang.String arg0)
Sets the name property.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

  1. public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005, 2011.
See Also:

ACTION_PROPERTY

  1. public static final java.lang.String ACTION_PROPERTY
Use the property name to determine labels and converters for the action property .
See Also:

ACTIVATIONSTATE_PROPERTY

  1. public static final java.lang.String ACTIVATIONSTATE_PROPERTY
Use the property name to determine labels and converters for the activationState property.
See Also:

ACTIVATIONTIME_PROPERTY

  1. public static final java.lang.String ACTIVATIONTIME_PROPERTY
Use the property name to determine labels and converters for the activationTime property.
See Also:

ATLEASTEXPECTEDSTATE_PROPERTY

  1. public static final java.lang.String ATLEASTEXPECTEDSTATE_PROPERTY
Use the property name to determine labels and converters for the atLeastExpectedState property.
See Also:

DESCRIPTION_PROPERTY

  1. public static final java.lang.String DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the description property.
See Also:

NAME_PROPERTY

  1. public static final java.lang.String NAME_PROPERTY
Use the property name to determine labels and converters for the name property.
See Also:

DURATIONUNTILESCALATED_PROPERTY

  1. public static final java.lang.String DURATIONUNTILESCALATED_PROPERTY
Use the property name to determine labels and converters for the durationUntilEscalated property.
See Also:

DURATIONUNTILREPEATED_PROPERTY

  1. public static final java.lang.String DURATIONUNTILREPEATED_PROPERTY
Use the property name to determine labels and converters for the durationUntilRepeated property.
See Also:

PRIORITY_INCREASE_PROPERTY

  1. public static final java.lang.String PRIORITY_INCREASE_PROPERTY
Use the property name to determine labels and converters for the priorityIncrease property.
See Also:

STATE_PROPERTY

  1. public static final java.lang.String STATE_PROPERTY
Use the property name to determine labels and converters for the state property.
See Also:

TASK_OWNER_PROPERTY

  1. public static final java.lang.String TASK_OWNER_PROPERTY
Use the property name to determine labels and converters for the taskOwner property.
See Also:

ESCALATION_RECEIVER_PROPERTY

  1. public static final java.lang.String ESCALATION_RECEIVER_PROPERTY
Use the property name to determine labels and converters for the escalationReceiver property.
See Also:

FIRST_ESCALATION_ID_PROPERTY

  1. public static final java.lang.String FIRST_ESCALATION_ID_PROPERTY
Use the property name to determine labels and converters for the firstEscalationID property.
See Also:

Constructor Detail

EscalationBean

  1. public EscalationBean(QueryResultSet resultSet,
  2. HTMConnection htmConnection)
Constructs a new EscalationBean from a QueryResultSet.
Parameters:
resultSet - The result object of a query.
htmConnection - The connection to the HumanTaskManagerService API.

EscalationBean

  1. public EscalationBean(Escalation esc,
  2. HTMConnection htmConnection)
Constructs a EscalationBean from an original Task object.
Parameters:
esc - The original data object.
htmConnection - The connection to the HumanTaskManagerService API.

EscalationBean

  1. protected EscalationBean(ESIID id,
  2. HTMConnection htmConnection,
  3. java.util.Locale locale)
Constructs a EscalationBean from an escalation instance id.
Parameters:
id - The escalation instance id.
htmConnection - The connection to the HumanTaskManagerService API.
locale - The locale of the locale dependant properties.

Method Detail

getConverter

  1. public static SimpleConverter getConverter( java.lang.String propertyName)
Returns the default converter for a given property.
Parameters:
propertyName - The name of the property.
Returns:
The converter instance if one has been registered with propertyName, null otherwise.

getLabel

  1. public static java.lang.String getLabel( java.lang.String propertyName)
Returns the resource bundle key for a property
Parameters:
propertyName - The name of the property.
Returns:
The resource bundle key for the property.

getLabel

  1. public static java.lang.String getLabel( java.lang.String propertyName,
  2. java.util.Locale locale)
Returns the label of a property from the resource bundle. If no label is found in the resource bundle, the resource bundle key for the property is returned.
Parameters:
propertyName - The name of the property.
locale - The locale.
Returns:
The label or the resource bundle key for the property.

isValid

  1. public static boolean isValid(java.lang.String propertyName)
Checks whether the property is valid.
Parameters:
propertyName - The name of the property to be checked.
Returns:
True if the property name is a known property for an object of this class.

getAction

  1. public int getAction()
Returns the action property.
Specified by:
getAction in interface Escalation
See Also:

getActivationState

  1. public int getActivationState()
Returns the activationState property.
Specified by:
See Also:

getActivationTime

  1. public java.util.Calendar getActivationTime( )
Returns the activationTime property.
Specified by:
See Also:

getAtLeastExpectedState

  1. public int getAtLeastExpectedState( )
Returns the atLeastExpectedState property.
Specified by:
See Also:

getContainmentContextID

  1. public OID getContainmentContextID( )
Returns the containmentContextID property.
Specified by:
See Also:

getDescription

  1. public com.ibm.bpc.clientcore.util.LocalisedString getDescription( )
Returns the localised description.
Returns:
The localised description.

getDescription

  1. public java.lang.String getDescription( java.util.Locale locale)
Returns the description property.
Specified by:
getDescription in interface Escalation
Parameters:
locale - The locale for which the description is to be provided.
See Also:

getDisplayName

  1. public com.ibm.bpc.clientcore.util.LocalisedString getDisplayName( )
Returns the localised display name.
Returns:
The localised display name.

getDisplayName

  1. public java.lang.String getDisplayName( java.util.Locale locale)
Returns the displayName property.
Specified by:
getDisplayName in interface Escalation
Parameters:
locale - The locale for which the display name is to be provided.
See Also:

getDurationUntilEscalated

  1. public java.lang.String getDurationUntilEscalated( )
Returns the durationUntilEscalated property.
Specified by:
See Also:

getDurationUntilRepeated

  1. public java.lang.String getDurationUntilRepeated( )
Returns the durationUntilRepeated property.
Specified by:
See Also:

getEscalationReceiver

  1. public java.lang.String getEscalationReceiver( )
Returns the escalationReceiver property.
Returns:
the receiver of the escalation

getEscalationTemplateID

  1. public ESTID getEscalationTemplateID( )
Returns the escalationTemplateID property.
Specified by:
See Also:

getFirstEscalationID

  1. public ESIID getFirstEscalationID( )
Returns the firstEscalationID property.
Specified by:
See Also:

getID

  1. public ESIID getID()
Returns the ID property.
Specified by:
getID in interface Escalation
See Also:

getLocalesOfDescriptions

  1. public java.util.List getLocalesOfDescriptions( )
Returns the localesOfDescriptions property.
Specified by:
See Also:

getLocalesOfDisplayNames

  1. public java.util.List getLocalesOfDisplayNames( )
Returns the localesOfDisplayNames property.
Specified by:
See Also:

getName

  1. public java.lang.String getName( )
Returns the name property.
Specified by:
getName in interface Escalation
See Also:

getNextEscalationID

  1. public ESIID getNextEscalationID( )
Returns the nextEscalationID property.
Specified by:
See Also:

getPreviousEscalationID

  1. public ESIID getPreviousEscalationID( )
Returns the previousEscalationID property.
Specified by:
See Also:

getPriorityIncrease

  1. public int getPriorityIncrease( )
Returns the priorityIncrease property.
Specified by:
See Also:

getState

  1. public int getState()
Returns the state property.
Specified by:
getState in interface Escalation
See Also:

getTaskInstanceID

  1. public TKIID getTaskInstanceID( )
Returns the taskInstanceID property.
Specified by:
See Also:

getTaskTemplateID

  1. public TKTID getTaskTemplateID( )
Returns the property tktid.
See Also:

getTaskName

  1. public java.lang.String getTaskName( )
Returns the taskName property.
Returns:
name of the task instance

getTaskOwner

  1. public java.lang.String getTaskOwner( )
Returns the taskOwner property.
Returns:
the owner of the task instance

setName

  1. public void setName(java.lang.String arg0)
Sets the name property.
Specified by:
setName in interface Escalation
Parameters:
arg0 - The new name of the escalation instance.
See Also:

isNameUpdateable

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

getEscalationTime

  1. public java.util.Calendar getEscalationTime( )
Returns the escalationTime property.
Specified by:
See Also:

setEscalationTime

  1. public void setEscalationTime(java.util.Calendar escalationTime)
Sets the name property.
Specified by:
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,
See Also:

isEscalationTimeUpdateable

  1. public boolean isEscalationTimeUpdateable( )
Signals whether the escalation time property can be changed for the kind and current state of the object.
Specified by:

setDurationUntilEscalated

  1. public void setDurationUntilEscalated( java.lang.String durationUntilEscalation)
Sets the durationUntilRepeated property.
Specified by:
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,
See Also:

isDurationUntilEscalatedUpdateable

  1. public boolean isDurationUntilEscalatedUpdateable( )
Signals whether the duration until escalation property can be changed for the kind and current state of the object.
Specified by:

setDurationUntilRepeated

  1. public void setDurationUntilRepeated( java.lang.String durationUntilRepeats)
Sets the durationUntilRepeated property.
Specified by:
Parameters:
durationUntilRepeats - The duration that should pass until the escalation instance fires next.
See Also:

isDurationUntilRepeatedUpdateable

  1. public boolean isDurationUntilRepeatedUpdateable( )
Signals whether the duration until repeats property can be changed for the kind and current state of the object.
Specified by: