com.ibm.task.clientmodel.bean
Class EscalationBean

java.lang.Object
  extended by com.ibm.task.clientmodel.bean.EscalationBean
All Implemented Interfaces:
Escalation, java.io.Serializable

public class EscalationBean
extends java.lang.Object
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
static java.lang.String ACTION_PROPERTY
          Use the property name to determine labels and converters for the action property .
static java.lang.String ACTIVATIONSTATE_PROPERTY
          Use the property name to determine labels and converters for the activationState property.
static java.lang.String ACTIVATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the activationTime property.
static java.lang.String ATLEASTEXPECTEDSTATE_PROPERTY
          Use the property name to determine labels and converters for the atLeastExpectedState property.
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005, 2010.
static java.lang.String DESCRIPTION_PROPERTY
          Use the property name to determine labels and converters for the description property.
static java.lang.String DURATIONUNTILESCALATED_PROPERTY
          Use the property name to determine labels and converters for the durationUntilEscalated property.
static java.lang.String DURATIONUNTILREPEATED_PROPERTY
          Use the property name to determine labels and converters for the durationUntilRepeated property.
static java.lang.String ESCALATION_RECEIVER_PROPERTY
          Use the property name to determine labels and converters for the escalationReceiver property.
static java.lang.String FIRST_ESCALATION_ID_PROPERTY
          Use the property name to determine labels and converters for the firstEscalationID property.
static java.lang.String NAME_PROPERTY
          Use the property name to determine labels and converters for the name property.
static java.lang.String PRIORITY_INCREASE_PROPERTY
          Use the property name to determine labels and converters for the priorityIncrease property.
static java.lang.String STATE_PROPERTY
          Use the property name to determine labels and converters for the state property.
static 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
  EscalationBean(Escalation esc, HTMConnection htmConnection)
          Constructs a EscalationBean from an original Task object.
protected EscalationBean(ESIID id, HTMConnection htmConnection, java.util.Locale locale)
          Constructs a EscalationBean from an escalation instance id.
  EscalationBean(QueryResultSet resultSet, HTMConnection htmConnection)
          Constructs a new EscalationBean from a QueryResultSet.
 
Method Summary
 int getAction()
          Returns the action property.
 int getActivationState()
          Returns the activationState property.
 java.util.Calendar getActivationTime()
          Returns the activationTime property.
 int getAtLeastExpectedState()
          Returns the atLeastExpectedState property.
 OID getContainmentContextID()
          Returns the containmentContextID property.
static SimpleConverter getConverter(java.lang.String propertyName)
          Returns the default converter for a given property.
 com.ibm.bpc.clientcore.util.LocalisedString getDescription()
          Returns the localised description.
 java.lang.String getDescription(java.util.Locale locale)
          Returns the description property.
 com.ibm.bpc.clientcore.util.LocalisedString getDisplayName()
          Returns the localised display name.
 java.lang.String getDisplayName(java.util.Locale locale)
          Returns the displayName property.
 java.lang.String getDurationUntilEscalated()
          Returns the durationUntilEscalated property.
 java.lang.String getDurationUntilRepeated()
          Returns the durationUntilRepeated property.
 java.lang.String getEscalationReceiver()
          Returns the escalationReceiver property.
 ESTID getEscalationTemplateID()
          Returns the escalationTemplateID property.
 java.util.Calendar getEscalationTime()
          Returns the escalationTime property.
 ESIID getFirstEscalationID()
          Returns the firstEscalationID property.
 ESIID getID()
          Returns the ID property.
static java.lang.String getLabel(java.lang.String propertyName)
          Returns the resource bundle key for a property
static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
          Returns the label of a property from the resource bundle.
 java.util.List getLocalesOfDescriptions()
          Returns the localesOfDescriptions property.
 java.util.List getLocalesOfDisplayNames()
          Returns the localesOfDisplayNames property.
 java.lang.String getName()
          Returns the name property.
 ESIID getNextEscalationID()
          Returns the nextEscalationID property.
 ESIID getPreviousEscalationID()
          Returns the previousEscalationID property.
 int getPriorityIncrease()
          Returns the priorityIncrease property.
 int getState()
          Returns the state property.
 TKIID getTaskInstanceID()
          Returns the taskInstanceID property.
 java.lang.String getTaskName()
          Returns the taskName property.
 java.lang.String getTaskOwner()
          Returns the taskOwner property.
 TKTID getTaskTemplateID()
          Returns the property tktid.
 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.
static boolean isValid(java.lang.String propertyName)
          Checks whether the property is valid.
 void setDurationUntilEscalated(java.lang.String durationUntilEscalation)
          Sets the durationUntilRepeated property.
 void setDurationUntilRepeated(java.lang.String durationUntilRepeats)
          Sets the durationUntilRepeated property.
 void setEscalationTime(java.util.Calendar escalationTime)
          Sets the name property.
 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005, 2010.

See Also:
Constant Field Values

ACTION_PROPERTY

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

See Also:
Constant Field Values

ACTIVATIONSTATE_PROPERTY

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

See Also:
Constant Field Values

ACTIVATIONTIME_PROPERTY

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

See Also:
Constant Field Values

ATLEASTEXPECTEDSTATE_PROPERTY

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

See Also:
Constant Field Values

DESCRIPTION_PROPERTY

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

See Also:
Constant Field Values

NAME_PROPERTY

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

See Also:
Constant Field Values

DURATIONUNTILESCALATED_PROPERTY

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

See Also:
Constant Field Values

DURATIONUNTILREPEATED_PROPERTY

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

See Also:
Constant Field Values

PRIORITY_INCREASE_PROPERTY

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

See Also:
Constant Field Values

STATE_PROPERTY

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

See Also:
Constant Field Values

TASK_OWNER_PROPERTY

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

See Also:
Constant Field Values

ESCALATION_RECEIVER_PROPERTY

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

See Also:
Constant Field Values

FIRST_ESCALATION_ID_PROPERTY

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:
Constant Field Values
Constructor Detail

EscalationBean

public EscalationBean(QueryResultSet resultSet,
                      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

public EscalationBean(Escalation esc,
                      HTMConnection htmConnection)
Constructs a EscalationBean from an original Task object.

Parameters:
esc - The original data object.
htmConnection - The connection to the HumanTaskManagerService API.

EscalationBean

protected EscalationBean(ESIID id,
                         HTMConnection htmConnection,
                         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

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

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

public static java.lang.String getLabel(java.lang.String propertyName,
                                        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

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

public int getAction()
Returns the action property.

Specified by:
getAction in interface Escalation
See Also:
Escalation.getAction()

getActivationState

public int getActivationState()
Returns the activationState property.

Specified by:
getActivationState in interface Escalation
See Also:
Escalation.getActivationState()

getActivationTime

public java.util.Calendar getActivationTime()
Returns the activationTime property.

Specified by:
getActivationTime in interface Escalation
See Also:
Escalation.getActivationTime()

getAtLeastExpectedState

public int getAtLeastExpectedState()
Returns the atLeastExpectedState property.

Specified by:
getAtLeastExpectedState in interface Escalation
See Also:
Escalation.getAtLeastExpectedState()

getContainmentContextID

public OID getContainmentContextID()
Returns the containmentContextID property.

Specified by:
getContainmentContextID in interface Escalation
See Also:
Escalation.getContainmentContextID()

getDescription

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

Returns:
The localised description.

getDescription

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:
Escalation.getDescription(java.util.Locale)

getDisplayName

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

Returns:
The localised display name.

getDisplayName

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:
Escalation.getDisplayName(java.util.Locale)

getDurationUntilEscalated

public java.lang.String getDurationUntilEscalated()
Returns the durationUntilEscalated property.

Specified by:
getDurationUntilEscalated in interface Escalation
See Also:
Escalation.getDurationUntilEscalated()

getDurationUntilRepeated

public java.lang.String getDurationUntilRepeated()
Returns the durationUntilRepeated property.

Specified by:
getDurationUntilRepeated in interface Escalation
See Also:
Escalation.getDurationUntilRepeated()

getEscalationReceiver

public java.lang.String getEscalationReceiver()
Returns the escalationReceiver property.

Returns:
the receiver of the escalation

getEscalationTemplateID

public ESTID getEscalationTemplateID()
Returns the escalationTemplateID property.

Specified by:
getEscalationTemplateID in interface Escalation
See Also:
Escalation.getEscalationTemplateID()

getFirstEscalationID

public ESIID getFirstEscalationID()
Returns the firstEscalationID property.

Specified by:
getFirstEscalationID in interface Escalation
See Also:
Escalation.getFirstEscalationID()

getID

public ESIID getID()
Returns the ID property.

Specified by:
getID in interface Escalation
See Also:
Escalation.getID()

getLocalesOfDescriptions

public java.util.List getLocalesOfDescriptions()
Returns the localesOfDescriptions property.

Specified by:
getLocalesOfDescriptions in interface Escalation
See Also:
Escalation.getLocalesOfDescriptions()

getLocalesOfDisplayNames

public java.util.List getLocalesOfDisplayNames()
Returns the localesOfDisplayNames property.

Specified by:
getLocalesOfDisplayNames in interface Escalation
See Also:
Escalation.getLocalesOfDisplayNames()

getName

public java.lang.String getName()
Returns the name property.

Specified by:
getName in interface Escalation
See Also:
Escalation.getName()

getNextEscalationID

public ESIID getNextEscalationID()
Returns the nextEscalationID property.

Specified by:
getNextEscalationID in interface Escalation
See Also:
Escalation.getNextEscalationID()

getPreviousEscalationID

public ESIID getPreviousEscalationID()
Returns the previousEscalationID property.

Specified by:
getPreviousEscalationID in interface Escalation
See Also:
Escalation.getPreviousEscalationID()

getPriorityIncrease

public int getPriorityIncrease()
Returns the priorityIncrease property.

Specified by:
getPriorityIncrease in interface Escalation
See Also:
Escalation.getPriorityIncrease()

getState

public int getState()
Returns the state property.

Specified by:
getState in interface Escalation
See Also:
Escalation.getState()

getTaskInstanceID

public TKIID getTaskInstanceID()
Returns the taskInstanceID property.

Specified by:
getTaskInstanceID in interface Escalation
See Also:
Escalation.getTaskInstanceID()

getTaskTemplateID

public TKTID getTaskTemplateID()
Returns the property tktid.

See Also:
Task.getTaskTemplateID()

getTaskName

public java.lang.String getTaskName()
Returns the taskName property.

Returns:
name of the task instance

getTaskOwner

public java.lang.String getTaskOwner()
Returns the taskOwner property.

Returns:
the owner of the task instance

setName

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:
Escalation.setName(java.lang.String)

isNameUpdateable

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

Specified by:
isNameUpdateable in interface Escalation

getEscalationTime

public java.util.Calendar getEscalationTime()
Returns the escalationTime property.

Specified by:
getEscalationTime in interface Escalation
See Also:
Escalation.getEscalationTime()

setEscalationTime

public void setEscalationTime(java.util.Calendar escalationTime)
Sets the name property.

Specified by:
setEscalationTime in interface Escalation
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:
com.ibm.task.api.Escalation#setEscalationTime(java.lang.Calendar)

isEscalationTimeUpdateable

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

Specified by:
isEscalationTimeUpdateable in interface Escalation

setDurationUntilEscalated

public void setDurationUntilEscalated(java.lang.String durationUntilEscalation)
Sets the durationUntilRepeated property.

Specified by:
setDurationUntilEscalated in interface Escalation
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:
Escalation.setDurationUntilRepeated(java.lang.String)

isDurationUntilEscalatedUpdateable

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

Specified by:
isDurationUntilEscalatedUpdateable in interface Escalation

setDurationUntilRepeated

public void setDurationUntilRepeated(java.lang.String durationUntilRepeats)
Sets the durationUntilRepeated property.

Specified by:
setDurationUntilRepeated in interface Escalation
Parameters:
durationUntilRepeats - The duration that should pass until the escalation instance fires next.
See Also:
Escalation.setDurationUntilRepeated(java.lang.String)

isDurationUntilRepeatedUpdateable

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

Specified by:
isDurationUntilRepeatedUpdateable in interface Escalation