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.
Escalation
,
QueryResultSet
,
Serialized FormModifier and Type | Field and Description |
---|---|
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, 2011.
|
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. |
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
Modifier | Constructor and Description |
---|---|
|
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 . |
Modifier and Type | Method and Description |
---|---|
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. |
public static final java.lang.String COPYRIGHT
public static final java.lang.String ACTION_PROPERTY
action
property .public static final java.lang.String ACTIVATIONSTATE_PROPERTY
activationState
property.public static final java.lang.String ACTIVATIONTIME_PROPERTY
activationTime
property.public static final java.lang.String ATLEASTEXPECTEDSTATE_PROPERTY
atLeastExpectedState
property.public static final java.lang.String DESCRIPTION_PROPERTY
description
property.public static final java.lang.String NAME_PROPERTY
name
property.public static final java.lang.String DURATIONUNTILESCALATED_PROPERTY
durationUntilEscalated
property.public static final java.lang.String DURATIONUNTILREPEATED_PROPERTY
durationUntilRepeated
property.public static final java.lang.String PRIORITY_INCREASE_PROPERTY
priorityIncrease
property.public static final java.lang.String STATE_PROPERTY
state
property.public static final java.lang.String TASK_OWNER_PROPERTY
taskOwner
property.public static final java.lang.String ESCALATION_RECEIVER_PROPERTY
escalationReceiver
property.public static final java.lang.String FIRST_ESCALATION_ID_PROPERTY
firstEscalationID
property.public EscalationBean(QueryResultSet resultSet, HTMConnection htmConnection)
EscalationBean
from a QueryResultSet
.resultSet
- The result object of a query.htmConnection
- The connection to the HumanTaskManagerService API.public EscalationBean(Escalation esc, HTMConnection htmConnection)
EscalationBean
from an original Task
object.esc
- The original data object.htmConnection
- The connection to the HumanTaskManagerService API.protected EscalationBean(ESIID id, HTMConnection htmConnection, java.util.Locale locale)
EscalationBean
from an escalation instance id.id
- The escalation instance id.htmConnection
- The connection to the HumanTaskManagerService API.locale
- The locale of the locale dependant properties.public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name of the property.public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name of the property.public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name of the property.locale
- The locale.public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked.public int getAction()
action
property.getAction
in interface Escalation
Escalation.getAction()
public int getActivationState()
activationState
property.getActivationState
in interface Escalation
Escalation.getActivationState()
public java.util.Calendar getActivationTime()
activationTime
property.getActivationTime
in interface Escalation
Escalation.getActivationTime()
public int getAtLeastExpectedState()
atLeastExpectedState
property.getAtLeastExpectedState
in interface Escalation
Escalation.getAtLeastExpectedState()
public OID getContainmentContextID()
containmentContextID
property.getContainmentContextID
in interface Escalation
Escalation.getContainmentContextID()
public com.ibm.bpc.clientcore.util.LocalisedString getDescription()
public java.lang.String getDescription(java.util.Locale locale)
description
property.getDescription
in interface Escalation
locale
- The locale for which the description is to be provided.Escalation.getDescription(java.util.Locale)
public com.ibm.bpc.clientcore.util.LocalisedString getDisplayName()
public java.lang.String getDisplayName(java.util.Locale locale)
displayName
property.getDisplayName
in interface Escalation
locale
- The locale for which the display name is to be provided.Escalation.getDisplayName(java.util.Locale)
public java.lang.String getDurationUntilEscalated()
durationUntilEscalated
property.getDurationUntilEscalated
in interface Escalation
Escalation.getDurationUntilEscalated()
public java.lang.String getDurationUntilRepeated()
durationUntilRepeated
property.getDurationUntilRepeated
in interface Escalation
Escalation.getDurationUntilRepeated()
public java.lang.String getEscalationReceiver()
escalationReceiver
property.public ESTID getEscalationTemplateID()
escalationTemplateID
property.getEscalationTemplateID
in interface Escalation
Escalation.getEscalationTemplateID()
public ESIID getFirstEscalationID()
firstEscalationID
property.getFirstEscalationID
in interface Escalation
Escalation.getFirstEscalationID()
public ESIID getID()
ID
property.getID
in interface Escalation
Escalation.getID()
public java.util.List getLocalesOfDescriptions()
localesOfDescriptions
property.getLocalesOfDescriptions
in interface Escalation
Escalation.getLocalesOfDescriptions()
public java.util.List getLocalesOfDisplayNames()
localesOfDisplayNames
property.getLocalesOfDisplayNames
in interface Escalation
Escalation.getLocalesOfDisplayNames()
public java.lang.String getName()
name
property.getName
in interface Escalation
Escalation.getName()
public ESIID getNextEscalationID()
nextEscalationID
property.getNextEscalationID
in interface Escalation
Escalation.getNextEscalationID()
public ESIID getPreviousEscalationID()
previousEscalationID
property.getPreviousEscalationID
in interface Escalation
Escalation.getPreviousEscalationID()
public int getPriorityIncrease()
priorityIncrease
property.getPriorityIncrease
in interface Escalation
Escalation.getPriorityIncrease()
public int getState()
state
property.getState
in interface Escalation
Escalation.getState()
public TKIID getTaskInstanceID()
taskInstanceID
property.getTaskInstanceID
in interface Escalation
Escalation.getTaskInstanceID()
public TKTID getTaskTemplateID()
tktid
.Task.getTaskTemplateID()
public java.lang.String getTaskName()
taskName
property.public java.lang.String getTaskOwner()
taskOwner
property.public void setName(java.lang.String arg0)
name
property.setName
in interface Escalation
arg0
- The new name of the escalation instance.Escalation.setName(java.lang.String)
public boolean isNameUpdateable()
isNameUpdateable
in interface Escalation
public java.util.Calendar getEscalationTime()
escalationTime
property.getEscalationTime
in interface Escalation
Escalation.getEscalationTime()
public void setEscalationTime(java.util.Calendar escalationTime)
name
property.setEscalationTime
in interface Escalation
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,Escalation.setEscalationTime(java.util.Calendar)
public boolean isEscalationTimeUpdateable()
isEscalationTimeUpdateable
in interface Escalation
public void setDurationUntilEscalated(java.lang.String durationUntilEscalation)
durationUntilRepeated
property.setDurationUntilEscalated
in interface Escalation
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,Escalation.setDurationUntilRepeated(java.lang.String)
public boolean isDurationUntilEscalatedUpdateable()
isDurationUntilEscalatedUpdateable
in interface Escalation
public void setDurationUntilRepeated(java.lang.String durationUntilRepeats)
durationUntilRepeated
property.setDurationUntilRepeated
in interface Escalation
durationUntilRepeats
- The duration that should pass until the escalation instance fires next.Escalation.setDurationUntilRepeated(java.lang.String)
public boolean isDurationUntilRepeatedUpdateable()
isDurationUntilRepeatedUpdateable
in interface Escalation