com.ibm.task.clientmodel.bean
Class EscalationBean
- java.lang.Object
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:
ID
taskInstanceID
action
activationState
activationTime
atLeastExpectedState
name
priorityIncrease
state
taskName
taskOwner
escalationReceiver
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:
Field Summary
Modifier and Type | Field and Description |
---|---|
|
ACTION_PROPERTY
Use the property name to determine labels and converters for the
action property .
|
|
ACTIVATIONSTATE_PROPERTY
Use the property name to determine labels and converters for the
activationState property.
|
|
ACTIVATIONTIME_PROPERTY
Use the property name to determine labels and converters for the
activationTime property.
|
|
ATLEASTEXPECTEDSTATE_PROPERTY
Use the property name to determine labels and converters for the
atLeastExpectedState property.
|
|
COPYRIGHT
(C) Copyright IBM Corporation 2005, 2011.
|
|
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the
description property.
|
|
DURATIONUNTILESCALATED_PROPERTY
Use the property name to determine labels and converters for the
durationUntilEscalated property.
|
|
DURATIONUNTILREPEATED_PROPERTY
Use the property name to determine labels and converters for the
durationUntilRepeated property.
|
|
ESCALATION_RECEIVER_PROPERTY
Use the property name to determine labels and converters for the
escalationReceiver property.
|
|
FIRST_ESCALATION_ID_PROPERTY
Use the property name to determine labels and converters for the
firstEscalationID property.
|
|
NAME_PROPERTY
Use the property name to determine labels and converters for the
name property.
|
|
PRIORITY_INCREASE_PROPERTY
Use the property name to determine labels and converters for the
priorityIncrease property.
|
|
STATE_PROPERTY
Use the property name to determine labels and converters for the
state property.
|
|
TASK_OWNER_PROPERTY
Use the property name to determine labels and converters for the
taskOwner property.
|
Constructor Summary
Modifier | Constructor and Description |
---|---|
|
EscalationBean(Escalation esc,HTMConnection htmConnection)
Constructs a
EscalationBean from an original Task object.
|
|
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
Modifier and Type | Method and Description |
---|---|
|
getAction()
Returns the
action property.
|
|
getActivationState()
Returns the
activationState property.
|
|
getActivationTime()
Returns the
activationTime property.
|
|
getAtLeastExpectedState()
Returns the
atLeastExpectedState property.
|
getContainmentContextID()
Returns the
containmentContextID property.
|
|
|
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
|
|
getDescription()
Returns the localised description.
|
|
getDescription(java.util.Locale locale)
Returns the
description property.
|
|
getDisplayName()
Returns the localised display name.
|
|
getDisplayName(java.util.Locale locale)
Returns the
displayName property.
|
|
getDurationUntilEscalated()
Returns the
durationUntilEscalated property.
|
|
getDurationUntilRepeated()
Returns the
durationUntilRepeated property.
|
|
getEscalationReceiver()
Returns the
escalationReceiver property.
|
getEscalationTemplateID()
Returns the
escalationTemplateID property.
|
|
|
getEscalationTime()
Returns the
escalationTime property.
|
getFirstEscalationID()
Returns the
firstEscalationID property.
|
|
getID()
Returns the
ID property.
|
|
|
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property
|
|
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label of a property from the resource bundle.
|
|
getLocalesOfDescriptions()
Returns the
localesOfDescriptions property.
|
|
getLocalesOfDisplayNames()
Returns the
localesOfDisplayNames property.
|
|
getName()
Returns the
name property.
|
getNextEscalationID()
Returns the
nextEscalationID property.
|
|
getPreviousEscalationID()
Returns the
previousEscalationID property.
|
|
|
getPriorityIncrease()
Returns the
priorityIncrease property.
|
|
getState()
Returns the
state property.
|
getTaskInstanceID()
Returns the
taskInstanceID property.
|
|
|
getTaskName()
Returns the
taskName property.
|
|
getTaskOwner()
Returns the
taskOwner property.
|
getTaskTemplateID()
Returns the property
tktid .
|
|
|
isDurationUntilEscalatedUpdateable()
Signals whether the duration until escalation property can be changed for the kind and current state of the object.
|
|
isDurationUntilRepeatedUpdateable()
Signals whether the duration until repeats property can be changed for the kind and current state of the object.
|
|
isEscalationTimeUpdateable()
Signals whether the escalation time property can be changed for the kind and current state of the object.
|
|
isNameUpdateable()
Signals whether the name property can be changed for the kind and current state of the object.
|
|
isValid(java.lang.String propertyName)
Checks whether the property is valid.
|
|
setDurationUntilEscalated(java.lang.String durationUntilEscalation)
Sets the
durationUntilRepeated property.
|
|
setDurationUntilRepeated(java.lang.String durationUntilRepeats)
Sets the
durationUntilRepeated property.
|
|
setEscalationTime(java.util.Calendar escalationTime)
Sets the
name property.
|
|
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, 2011.
See Also:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
getActivationState
- public int getActivationState()
Returns the
activationState
property.
Specified by:
getActivationState
in interface Escalation
See Also:
getActivationTime
- public java.util.Calendar getActivationTime( )
Returns the
activationTime
property.
Specified by:
getActivationTime
in interface Escalation
See Also:
getAtLeastExpectedState
- public int getAtLeastExpectedState( )
Returns the
atLeastExpectedState
property.
Specified by:
getAtLeastExpectedState
in interface Escalation
See Also:
getContainmentContextID
- public OID getContainmentContextID( )
Returns the
containmentContextID
property.
Specified by:
getContainmentContextID
in interface Escalation
See Also:
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:
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:
getDurationUntilEscalated
- public java.lang.String getDurationUntilEscalated( )
Returns the
durationUntilEscalated
property.
Specified by:
getDurationUntilEscalated
in interface Escalation
See Also:
getDurationUntilRepeated
- public java.lang.String getDurationUntilRepeated( )
Returns the
durationUntilRepeated
property.
Specified by:
getDurationUntilRepeated
in interface Escalation
See Also:
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:
getFirstEscalationID
- public ESIID getFirstEscalationID( )
Returns the
firstEscalationID
property.
Specified by:
getFirstEscalationID
in interface Escalation
See Also:
getID
- public ESIID getID()
Returns the
ID
property.
Specified by:
getID
in interface Escalation
See Also:
getLocalesOfDescriptions
- public java.util.List getLocalesOfDescriptions( )
Returns the
localesOfDescriptions
property.
Specified by:
getLocalesOfDescriptions
in interface Escalation
See Also:
getLocalesOfDisplayNames
- public java.util.List getLocalesOfDisplayNames( )
Returns the
localesOfDisplayNames
property.
Specified by:
getLocalesOfDisplayNames
in interface Escalation
See Also:
getName
- public java.lang.String getName( )
Returns the
name
property.
Specified by:
getName
in interface Escalation
See Also:
getNextEscalationID
- public ESIID getNextEscalationID( )
Returns the
nextEscalationID
property.
Specified by:
getNextEscalationID
in interface Escalation
See Also:
getPreviousEscalationID
- public ESIID getPreviousEscalationID( )
Returns the
previousEscalationID
property.
Specified by:
getPreviousEscalationID
in interface Escalation
See Also:
getPriorityIncrease
- public int getPriorityIncrease( )
Returns the
priorityIncrease
property.
Specified by:
getPriorityIncrease
in interface Escalation
See Also:
getState
- public int getState()
Returns the
state
property.
Specified by:
getState
in interface Escalation
See Also:
getTaskInstanceID
- public TKIID getTaskInstanceID( )
Returns the
taskInstanceID
property.
Specified by:
getTaskInstanceID
in interface Escalation
See Also:
getTaskTemplateID
- public TKTID getTaskTemplateID( )
Returns the property
tktid
.
See Also:
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:
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:
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:
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:
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:
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