com.ibm.bpe.clientmodel.bean
Class ActivityInstanceBean
- java.lang.Object
com.ibm.bpe.clientmodel.bean.ActivityInstanceBean
- public class ActivityInstanceBean
- extends java.lang.Object
- implements ActivityInstanceData
Accesses the properties of the original ActivityInstanceData
object
and adds metadata for national language support and converters.
An ActivityInstanceBean
object can be instantiated from either a
QueryResultSet
object or an ActivityInstanceData
object.
If the bean was instantiated from an original object returned by the Business
Process Choreographer API, all properties are loaded. If, however, the bean
is instantiated from a query only the following properties are loaded from
the query result set:
ID
activationTime
completionTime
description
expirationTime
kind
owner
startTime
executionState
activityName
processInstanceName
processTemplateName
processTemplateDisplayName
stopReason
subState
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. As converters are optional, the return value might be null.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
ACTIVATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the
"activation time" property.
|
|
APPLICATIONNAME_PROPERTY
Uses the property name to determine labels and converters for the
"application name" property.
|
|
AVAILABLEACTIONS_PROPERTY
Uses the property name to determine labels and converters for the
"available actions" property.
|
|
COMPLETIONTIME_PROPERTY
Uses the property name to determine labels and converters for the
"completion time" property.
|
|
CONTINUEONERROR_PROPERTY
Use the property name to determine labels and converters for the
continueOnError property.
|
|
COPYRIGHT
(C) Copyright IBM Corporation 2004, 2010.
|
|
CUSTOMPROPERTY_PROPERTY
Uses the property name to determine labels and converters for the
"custom properties" property.
|
|
DESCRIPTION_PROPERTY
Uses the property name to determine labels and converters for the
"description" property.
|
|
DISPLAYNAME_PROPERTY
Uses the property name to determine labels and converters for the
"display name" property.
|
|
EXECUTIONSTATE_PROPERTY
Uses the property name to determine labels and converters for the
"execution state" property.
|
|
EXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the
"expiration time" property.
|
|
FAULTNAMES_PROPERTY
Uses the property name to determine labels and converters for the
"fault name" property.
|
|
ID_PROPERTY
Uses the property name to determine labels and converters for the "ID"
property.
|
|
INPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the
"input message type name" property.
|
|
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
|
|
KIND_PROPERTY
Uses the property name to determine labels and converters for the "kind"
property.
|
|
LASTMODIFICATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the
"last modification time" property.
|
|
LASTSTATECHANGETIME_PROPERTY
Uses the property name to determine labels and converters for the
"last state change time" property.
|
|
NAME_PROPERTY
Uses the property name to determine labels and converters for the "name"
property.
|
|
OUTPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the
"output message type name" property.
|
|
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
|
|
OWNER_PROPERTY
Uses the property name to determine labels and converters for the "owner"
property.
|
|
PREVIOUSEXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the
"expiration time" property.
|
|
PROCESSADMINISTRATORS_PROPERTY
Uses the property name to determine labels and converters for the
"process administrators" property.
|
|
PROCESSINSTANCEID_PROPERTY
Uses the property name to determine labels and converters for the
"process instance ID" property.
|
|
PROCESSINSTANCENAME_PROPERTY
Uses the property name to determine labels and converters for the
"process instance name" property.
|
|
PROCESSTEMPLATEDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the
processTemplateDisplayName property.
|
|
PROCESSTEMPLATEID_PROPERTY
Uses the property name to determine labels and converters for the
"process template ID" property.
|
|
PROCESSTEMPLATENAME_PROPERTY
Uses the property name to determine labels and converters for the
"process template name" property.
|
|
SKIPREQUESTED_PROPERTY
Uses the property name to determine labels and converters for the
"skipRequested" property.
|
|
STARTTIME_PROPERTY
Uses the property name to determine labels and converters for the
"start time" property.
|
|
STOPREASON_PROPERTY
Uses the property name to determine labels and converters for the
"stopReason" property.
|
|
SUBSTATE_PROPERTY
Uses the property name to determine labels and converters for the
"subState" property.
|
|
UNHANDLEDEXCEPTION_PROPERTY
Uses the property name to determine labels and converters for the
"unhandled exception" property.
|
Constructor Summary
Modifier | Constructor and Description |
---|---|
|
ActivityInstanceBean(ActivityInstanceData activity,BFMConnection bfmConnection)
Constructs a new
ActivityInstanceBean from an original ActivityInstanceData object.
|
|
ActivityInstanceBean(AIID id,BFMConnection bfmConnection)
Constructs a new
ActivityInstanceBean from an activity
instance id.
|
|
ActivityInstanceBean(QueryResultSet resultSet,BFMConnection bfmConnection)
Constructs a new
ActivityInstanceBean from a QueryResultSet .
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getActivationTime()
Returns the
activationTime property.
|
|
getActivityClaimed()
Returns true if
executionState is of state CLAIMED, returns
false otherwise
|
getActivityTemplateID()
Returns the
activityTemplateID property.
|
|
getAdminTaskID()
Returns the
adminTaskID property.
|
|
|
getApplicationName()
Returns the
applicationName property.
|
|
getAvailableActions()
Returns the
availableActions property.
|
|
getCompletionTime()
Returns the
completionTime property.
|
|
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
|
|
getCustomProperty(java.lang.String arg)
Returns the
customProperty property.
|
|
getDescription()
Returns the
description property.
|
|
getDisplayName()
Returns the
displayName property.
|
|
getEnclosingForEachID()
Returns the
enclosingForEachID property.
|
|
getEventHandlerInstanceID()
Returns the
eventHandlerInstanceID property.
|
|
getExecutionState()
Returns the
executionState property.
|
|
getExpirationTime()
Returns the
expirationTime property.
|
getFaultMessageWrapper()
Retrieves the fault message.
|
|
|
getFaultNames()
Returns the
faultNames property.
|
getID()
Returns the
ID property.
|
|
|
getInputMessageTypeName()
Returns the
inputMessageTypeName property.
|
|
getInputMessageTypeTypeSystemName()
Deprecated.
|
getInputMessageWrapper()
Retrieves the input message.
|
|
getInvokedInstanceID()
Returns the
invokedInstanceID property.
|
|
|
getInvokedInstanceType()
Returns the
invokedInstanceType property.
|
|
getKind()
Returns the
kind 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.
|
|
getLastModificationTime()
Returns the
lastModificationTime property.
|
|
getLastStateChangeTime()
Returns the
lastStateChangeTime property.
|
|
getName()
Returns the
name property.
|
|
getNamesOfCustomProperties()
Returns the
namesOfCustomProperties() property.
|
|
getOutputMessageTypeName()
Returns the
outputMessageTypeName property.
|
|
getOutputMessageTypeTypeSystemName()
Deprecated.
|
getOutputMessageWrapper()
Retrieves the output message.
|
|
|
getOwner()
Returns the
owner property.
|
|
getPreviousExpirationTime()
Returns the time the activity instance expired for the first time.
|
getProcessAdministrators()
Returns the
processAdministrators property.
|
|
getProcessAdminTaskID()
Returns the
processAdminTaskID property.
|
|
getProcessInstanceID()
Returns the
processInstanceID property.
|
|
|
getProcessInstanceName()
Returns the
processInstanceName property.
|
|
getProcessTemplateDisplayName()
Returns the
processTemplateDisplayName property.
|
getProcessTemplateID()
Returns the
processTemplateID property.
|
|
|
getProcessTemplateName()
Returns the
processTemplateName property.
|
|
getScopeID()
Returns the
scopeID property.
|
|
getScopeTemplateID()
Returns the
scopeTemplateID property.
|
|
getStartTime()
Returns the
startTime property.
|
|
getStopReason()
Returns the
stopReason property.
|
|
getSubState()
Returns the
subState property.
|
getTaskID()
Returns the
taskID property.
|
|
getUnhandledException()
Returns the
unhandledException property.
|
|
|
isBusinessRelevant()
Returns the
businessRelevant property.
|
|
isContinueOnError()
Returns the
continueOnError property.
|
|
isSkipRequested()
Returns the
skipRequested property.
|
|
isValid(java.lang.String propertyName)
Checks that the property is valid.
|
|
setExecutionState(int state)
Changes the activity's
executionState 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
ACTIVATIONTIME_PROPERTY
- public static final java.lang.String ACTIVATIONTIME_PROPERTY
APPLICATIONNAME_PROPERTY
- public static final java.lang.String APPLICATIONNAME_PROPERTY
AVAILABLEACTIONS_PROPERTY
- public static final java.lang.String AVAILABLEACTIONS_PROPERTY
COMPLETIONTIME_PROPERTY
- public static final java.lang.String COMPLETIONTIME_PROPERTY
CUSTOMPROPERTY_PROPERTY
- public static final java.lang.String CUSTOMPROPERTY_PROPERTY
CONTINUEONERROR_PROPERTY
- public static final java.lang.String CONTINUEONERROR_PROPERTY
continueOnError
property.
DESCRIPTION_PROPERTY
- public static final java.lang.String DESCRIPTION_PROPERTY
DISPLAYNAME_PROPERTY
- public static final java.lang.String DISPLAYNAME_PROPERTY
EXECUTIONSTATE_PROPERTY
- public static final java.lang.String EXECUTIONSTATE_PROPERTY
EXPIRATIONTIME_PROPERTY
- public static final java.lang.String EXPIRATIONTIME_PROPERTY
FAULTNAMES_PROPERTY
- public static final java.lang.String FAULTNAMES_PROPERTY
ID_PROPERTY
- public static final java.lang.String ID_PROPERTY
INPUTMESSAGETYPENAME_PROPERTY
- public static final java.lang.String INPUTMESSAGETYPENAME_PROPERTY
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
- public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
KIND_PROPERTY
- public static final java.lang.String KIND_PROPERTY
LASTMODIFICATIONTIME_PROPERTY
- public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
LASTSTATECHANGETIME_PROPERTY
- public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
NAME_PROPERTY
- public static final java.lang.String NAME_PROPERTY
OUTPUTMESSAGETYPENAME_PROPERTY
- public static final java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
- public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
OWNER_PROPERTY
- public static final java.lang.String OWNER_PROPERTY
PREVIOUSEXPIRATIONTIME_PROPERTY
- public static final java.lang.String PREVIOUSEXPIRATIONTIME_PROPERTY
PROCESSADMINISTRATORS_PROPERTY
- public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
PROCESSINSTANCEID_PROPERTY
- public static final java.lang.String PROCESSINSTANCEID_PROPERTY
PROCESSINSTANCENAME_PROPERTY
- public static final java.lang.String PROCESSINSTANCENAME_PROPERTY
PROCESSTEMPLATEID_PROPERTY
- public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
PROCESSTEMPLATENAME_PROPERTY
- public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
PROCESSTEMPLATEDISPLAYNAME_PROPERTY
- public static final java.lang.String PROCESSTEMPLATEDISPLAYNAME_PROPERTY
processTemplateDisplayName
property.
STARTTIME_PROPERTY
- public static final java.lang.String STARTTIME_PROPERTY
UNHANDLEDEXCEPTION_PROPERTY
- public static final java.lang.String UNHANDLEDEXCEPTION_PROPERTY
STOPREASON_PROPERTY
- public static final java.lang.String STOPREASON_PROPERTY
SKIPREQUESTED_PROPERTY
- public static final java.lang.String SKIPREQUESTED_PROPERTY
SUBSTATE_PROPERTY
- public static final java.lang.String SUBSTATE_PROPERTY
Constructor Detail
ActivityInstanceBean
- public ActivityInstanceBean(ActivityInstanceData activity,
- BFMConnection bfmConnection)
ActivityInstanceBean
from an original
ActivityInstanceData
object.
activity
- The original data object. bfmConnection
- The connection to the BusinessFlowManagerService API. ActivityInstanceBean
- protected ActivityInstanceBean( AIID id,
- BFMConnection bfmConnection)
ActivityInstanceBean
from an activity
instance id.
id
- The activity instance id. bfmConnection
- The connection to the BusinessFlowManagerService API. ActivityInstanceBean
- public ActivityInstanceBean(QueryResultSet resultSet,
- BFMConnection bfmConnection)
ActivityInstanceBean
from a
QueryResultSet
.
resultSet
- The result object of a query. bfmConnection
- The connection to the BusinessFlowManagerService API. Method Detail
getConverter
- public static SimpleConverter getConverter( java.lang.String propertyName)
propertyName
- The name of the property. propertyName
. Null otherwise. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName)
propertyName
- The name of the property. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName,
- java.util.Locale locale)
propertyName
- The name of the property. locale
- The locale. isValid
- public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked. propertyName
is a known
property for an object of this class. getActivationTime
- public java.util.Calendar getActivationTime( )
activationTime
property.
getActivationTime
in interface ActivityInstanceData
getAdminTaskID
- public TKIID getAdminTaskID()
adminTaskID
property.
getAdminTaskID
in interface ActivityInstanceData
getProcessAdminTaskID
- public TKIID getProcessAdminTaskID( )
processAdminTaskID
property.
getProcessAdminTaskID
in interface ActivityInstanceData
getInvokedInstanceID
- public OID getInvokedInstanceID( )
invokedInstanceID
property.
getInvokedInstanceID
in interface ActivityInstanceData
getInvokedInstanceType
- public int getInvokedInstanceType( )
invokedInstanceType
property.
getInvokedInstanceType
in interface ActivityInstanceData
getActivityTemplateID
- public ATID getActivityTemplateID( )
activityTemplateID
property.
getActivityTemplateID
in interface ActivityInstanceData
getApplicationName
- public java.lang.String getApplicationName( )
applicationName
property.
getApplicationName
in interface ActivityInstanceData
getAvailableActions
- public int[] getAvailableActions( )
availableActions
property.
getAvailableActions
in interface ActivityInstanceData
getCompletionTime
- public java.util.Calendar getCompletionTime( )
completionTime
property.
getCompletionTime
in interface ActivityInstanceData
getCustomProperty
- public java.lang.String getCustomProperty( java.lang.String arg)
customProperty
property.
getCustomProperty
in interface ActivityInstanceData
arg
- The name of the custom property for which the value is to be read. getDescription
- public java.lang.String getDescription( )
description
property.
getDescription
in interface ActivityInstanceData
getDisplayName
- public java.lang.String getDisplayName( )
displayName
property.
getDisplayName
in interface ActivityInstanceData
getExecutionState
- public int getExecutionState()
executionState
property. This property may be
set by a client application. Therefore, the local property takes
precedence over the object's property originally retrieved from the
server.
getExecutionState
in interface ActivityInstanceData
setExecutionState
- public void setExecutionState(int state)
executionState
property. This can
happen, for example, when an activity was claimed through the Business
Process Choreographer Explorer. Be aware that the
ActivityInstanceBean
object and the
ActivityInstanceData
server object may differ, so the object
should be refreshed if necessary.
state
- The new state of the activity instance. getExpirationTime
- public java.util.Calendar getExpirationTime( )
expirationTime
property.
getExpirationTime
in interface ActivityInstanceData
getFaultNames
- public java.util.List getFaultNames( )
faultNames
property.
getFaultNames
in interface ActivityInstanceData
getID
- public AIID getID()
ID
property.
getID
in interface ActivityInstanceData
getInputMessageTypeName
- public java.lang.String getInputMessageTypeName( )
inputMessageTypeName
property.
getInputMessageTypeName
in interface ActivityInstanceData
getInputMessageTypeTypeSystemName
- public java.lang.String getInputMessageTypeTypeSystemName( )
inputMessageTypeTypeSystemName
property.
getInputMessageTypeTypeSystemName
in interface ActivityInstanceData
getKind
- public int getKind()
kind
property.
getKind
in interface ActivityInstanceData
getLastModificationTime
- public java.util.Calendar getLastModificationTime( )
lastModificationTime
property.
getLastModificationTime
in interface ActivityInstanceData
getLastStateChangeTime
- public java.util.Calendar getLastStateChangeTime( )
lastStateChangeTime
property.
getLastStateChangeTime
in interface ActivityInstanceData
getName
- public java.lang.String getName( )
name
property.
getName
in interface ActivityInstanceData
getNamesOfCustomProperties
- public java.util.List getNamesOfCustomProperties( )
namesOfCustomProperties()
property.
getNamesOfCustomProperties
in interface ActivityInstanceData
getOutputMessageTypeName
- public java.lang.String getOutputMessageTypeName( )
outputMessageTypeName
property.
getOutputMessageTypeName
in interface ActivityInstanceData
getOutputMessageTypeTypeSystemName
- public java.lang.String getOutputMessageTypeTypeSystemName( )
outputMessageTypeTypeSystemName
property.
getOutputMessageTypeTypeSystemName
in interface ActivityInstanceData
getOwner
- public java.lang.String getOwner( )
owner
property.
getOwner
in interface ActivityInstanceData
getProcessAdministrators
- public StaffResultSet getProcessAdministrators( )
- throws WorkItemManagerException
- InvalidLengthException
processAdministrators
property.
getProcessAdministrators
in interface ActivityInstanceData
getProcessInstanceID
- public PIID getProcessInstanceID( )
processInstanceID
property.
getProcessInstanceID
in interface ActivityInstanceData
getProcessInstanceName
- public java.lang.String getProcessInstanceName( )
processInstanceName
property.
getProcessInstanceName
in interface ActivityInstanceData
getProcessTemplateID
- public PTID getProcessTemplateID( )
processTemplateID
property.
getProcessTemplateID
in interface ActivityInstanceData
getProcessTemplateName
- public java.lang.String getProcessTemplateName( )
processTemplateName
property.
getProcessTemplateName
in interface ActivityInstanceData
getProcessTemplateDisplayName
- public java.lang.String getProcessTemplateDisplayName( )
processTemplateDisplayName
property. Returns the
processTemplateName
property when a display name is not
assigned.
getStartTime
- public java.util.Calendar getStartTime( )
startTime
property.
getStartTime
in interface ActivityInstanceData
getTaskID
- public TKIID getTaskID()
taskID
property.
getTaskID
in interface ActivityInstanceData
getScopeID
- public com.ibm.bpe.api.SIID getScopeID( )
scopeID
property.
getScopeID
in interface ActivityInstanceData
getScopeTemplateID
- public com.ibm.bpe.api.STID getScopeTemplateID( )
scopeTemplateID
property.
getScopeTemplateID
in interface ActivityInstanceData
getEventHandlerInstanceID
- public com.ibm.bpe.api.EHIID getEventHandlerInstanceID( )
eventHandlerInstanceID
property.
getEventHandlerInstanceID
in interface ActivityInstanceData
getEnclosingForEachID
- public com.ibm.bpe.api.FEIID getEnclosingForEachID( )
enclosingForEachID
property.
getEnclosingForEachID
in interface ActivityInstanceData
getUnhandledException
- public ProcessException getUnhandledException( )
unhandledException
property.
getUnhandledException
in interface ActivityInstanceData
getStopReason
- public int getStopReason()
stopReason
property.
getStopReason
in interface ActivityInstanceData
getSubState
- public int getSubState()
subState
property.
getSubState
in interface ActivityInstanceData
isBusinessRelevant
- public boolean isBusinessRelevant( )
businessRelevant
property.
isBusinessRelevant
in interface ActivityInstanceData
getActivityClaimed
- public boolean getActivityClaimed( )
executionState
is of state CLAIMED, returns
false otherwise
getInputMessageWrapper
- public MessageWrapper getInputMessageWrapper( )
- throws ClientException
getOutputMessageWrapper
- public MessageWrapper getOutputMessageWrapper( )
- throws ClientException
getFaultMessageWrapper
- public MessageWrapper getFaultMessageWrapper( )
- throws ClientException
isSkipRequested
- public boolean isSkipRequested( )
skipRequested
property.
isSkipRequested
in interface ActivityInstanceData
isContinueOnError
- public boolean isContinueOnError( )
continueOnError
property.
isContinueOnError
in interface ActivityInstanceData
getPreviousExpirationTime
- public java.util.Calendar getPreviousExpirationTime( )
getPreviousExpirationTime
in interface ActivityInstanceData