|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.clientmodel.bean.ActivityInstanceBean
Accesses the properties of the original ActivityInstanceData
object
and adds metadata for national language support and converters.
An ActivityInstanceBean
object can be instantiated from a QueryResultSet
object
or from an ActivityInstanceData
object.
If the bean was instantiated from an original object returned by the Business Process
Choreographer API, all properties are loaded. If the bean is instantiated from a query
only the following properties are going to be loaded from the query result set:
ID
name
executionState
kind
activationTime
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 may be null because converters
are optional.
ActivityInstanceData
,
QueryResultSet
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ACTIVATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property activiation time. |
static java.lang.String |
APPLICATIONNAME_PROPERTY
Use the property name to determine labels and converters for the property application name. |
static java.lang.String |
AVAILABLEACTIONS_PROPERTY
Use the property name to determine labels and converters for the property available actions. |
static java.lang.String |
COMPLETIONTIME_PROPERTY
Use the property name to determine labels and converters for the property completion time. |
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2004, 2005. |
static java.lang.String |
CUSTOMPROPERTY_PROPERTY
Use the property name to determine labels and converters for the property custom properties. |
static java.lang.String |
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the property description. |
static java.lang.String |
DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the property display name. |
static java.lang.String |
EXECUTIONSTATE_PROPERTY
Use the property name to determine labels and converters for the property execution state. |
static java.lang.String |
EXPIRATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property expiration time. |
static java.lang.String |
FAULTNAMES_PROPERTY
Use the property name to determine labels and converters for the property fault name. |
static java.lang.String |
ID_PROPERTY
Use the property name to determine labels and converters for the property ID. |
static java.lang.String |
INPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the property input message type name. |
static java.lang.String |
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Use the property name to determine labels and converters for the property input message type system name. |
static java.lang.String |
KIND_PROPERTY
Use the property name to determine labels and converters for the property kind. |
static java.lang.String |
LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property last modification time. |
static java.lang.String |
LASTSTATECHANGETIME_PROPERTY
Use the property name to determine labels and converters for the property last state change time. |
static java.lang.String |
NAME_PROPERTY
Use the property name to determine labels and converters for the property name. |
static java.lang.String |
OUTPUTMESSAGETYPENAME_PROPERTY
Use the property name to determine labels and converters for the property output message type name. |
static java.lang.String |
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Use the property name to determine labels and converters for the property output message type system name. |
static java.lang.String |
OWNER_PROPERTY
Use the property name to determine labels and converters for the property owner. |
static java.lang.String |
PROCESSADMINISTRATORS_PROPERTY
Use the property name to determine labels and converters for the property process administrators. |
static java.lang.String |
PROCESSINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the property process instance ID. |
static java.lang.String |
PROCESSINSTANCENAME_PROPERTY
Use the property name to determine labels and converters for the property process instance name. |
static java.lang.String |
PROCESSTEMPLATEID_PROPERTY
Use the property name to determine labels and converters for the property process template ID. |
static java.lang.String |
PROCESSTEMPLATENAME_PROPERTY
Use the property name to determine labels and converters for the property process template name. |
static java.lang.String |
STARTTIME_PROPERTY
Use the property name to determine labels and converters for the property start time. |
static java.lang.String |
UNHANDLEDEXCEPTION_PROPERTY
Use the property name to determine labels and converters for the property unhandled exception. |
Fields inherited from interface com.ibm.bpe.api.ActivityInstanceData |
---|
KIND_ASSIGN, KIND_COMPENSATE, KIND_CUSTOM, KIND_EMPTY, KIND_FLOW, KIND_FLOW_END, KIND_INVOKE, KIND_INVOKE_END, KIND_PICK, KIND_PICK_END, KIND_RECEIVE, KIND_REPLY, KIND_RETHROW, KIND_SCOPE, KIND_SCOPE_END, KIND_SCRIPT, KIND_SEQUENCE, KIND_SEQUENCE_END, KIND_STAFF, KIND_SWITCH, KIND_SWITCH_END, KIND_TERMINATE, KIND_THROW, KIND_WAIT, KIND_WHILE, KIND_WHILE_END, STATE_CLAIMED, STATE_EXPIRED, STATE_FAILED, STATE_FAILING, STATE_FINISHED, STATE_INACTIVE, STATE_PROCESSING_UNDO, STATE_READY, STATE_RUNNING, STATE_SKIPPED, STATE_STOPPED, STATE_TERMINATED, STATE_TERMINATING, STATE_WAITING |
Constructor Summary | |
---|---|
ActivityInstanceBean(com.ibm.bpe.api.ActivityInstanceData activity,
BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from an original ActivityInstanceData object. |
|
ActivityInstanceBean(com.ibm.bpe.api.QueryResultSet resultSet,
BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from a QueryResultSet . |
Method Summary | |
---|---|
java.util.Calendar |
getActivationTime()
Returns the property activationTime . |
com.ibm.task.api.TKIID |
getAdminTaskID()
Returns the property adminTaskID . |
java.lang.String |
getApplicationName()
Returns the property applicationName . |
int[] |
getAvailableActions()
Returns the property availableActions . |
java.util.Calendar |
getCompletionTime()
Returns the property completionTime . |
static SimpleConverter |
getConverter(java.lang.String propertyName)
Returns the default converter for a given property. |
java.lang.String |
getCustomProperty(java.lang.String arg)
Returns the property customProperty . |
java.lang.String |
getDescription()
Returns the property description . |
java.lang.String |
getDisplayName()
Returns the property displayName . |
int |
getExecutionState()
Returns the property executionState . |
java.util.Calendar |
getExpirationTime()
Returns the property expirationTime . |
MessageWrapper |
getFaultMessageWrapper()
Retrieves the fault message. |
java.util.List |
getFaultNames()
Returns the property faultNames . |
com.ibm.bpe.api.AIID |
getID()
Returns the property ID . |
java.lang.String |
getInputMessageTypeName()
Returns the property inputMessageTypeName . |
java.lang.String |
getInputMessageTypeTypeSystemName()
Returns the property inputMessageTypeTypeSystemName . |
MessageWrapper |
getInputMessageWrapper()
Retrieves the input message. |
int |
getKind()
Returns the property kind . |
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 for a property from the resource bundle. |
java.util.Calendar |
getLastModificationTime()
Returns the property lastModificationTime . |
java.util.Calendar |
getLastStateChangeTime()
Returns the property lastStateChangeTime . |
java.lang.String |
getName()
Returns the property name . |
java.util.List |
getNamesOfCustomProperties()
Returns the property namesOfCustomProperties() . |
java.lang.String |
getOutputMessageTypeName()
Returns the property outputMessageTypeName . |
java.lang.String |
getOutputMessageTypeTypeSystemName()
Returns the property outputMessageTypeTypeSystemName . |
MessageWrapper |
getOutputMessageWrapper()
Retrieves the output message. |
java.lang.String |
getOwner()
Returns the property owner . |
com.ibm.bpe.api.StaffResultSet |
getProcessAdministrators()
Returns the property processAdministrators . |
com.ibm.bpe.api.PIID |
getProcessInstanceID()
Returns the property processInstanceID . |
java.lang.String |
getProcessInstanceName()
Returns the property processInstanceName . |
com.ibm.bpe.api.PTID |
getProcessTemplateID()
Returns the property processTemplateID . |
java.lang.String |
getProcessTemplateName()
Returns the property processTemplateName . |
java.util.Calendar |
getStartTime()
Returns the property startTime . |
com.ibm.task.api.TKIID |
getTaskID()
Returns the property taskID . |
com.ibm.bpe.api.ProcessException |
getUnhandledException()
Returns the property unhandledException . |
boolean |
isBusinessRelevant()
Returns the property businessRelevant . |
static boolean |
isValid(java.lang.String propertyName)
Checks if the property is valid. |
void |
setExecutionState(int state)
Changes the property executionState of the activity. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String COPYRIGHT
public static java.lang.String ACTIVATIONTIME_PROPERTY
public static java.lang.String APPLICATIONNAME_PROPERTY
public static java.lang.String AVAILABLEACTIONS_PROPERTY
public static java.lang.String COMPLETIONTIME_PROPERTY
public static java.lang.String CUSTOMPROPERTY_PROPERTY
public static java.lang.String DESCRIPTION_PROPERTY
public static java.lang.String DISPLAYNAME_PROPERTY
public static java.lang.String EXECUTIONSTATE_PROPERTY
public static java.lang.String EXPIRATIONTIME_PROPERTY
public static java.lang.String FAULTNAMES_PROPERTY
public static java.lang.String ID_PROPERTY
public static java.lang.String INPUTMESSAGETYPENAME_PROPERTY
public static java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
public static java.lang.String KIND_PROPERTY
public static java.lang.String LASTMODIFICATIONTIME_PROPERTY
public static java.lang.String LASTSTATECHANGETIME_PROPERTY
public static java.lang.String NAME_PROPERTY
public static java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
public static java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
public static java.lang.String OWNER_PROPERTY
public static java.lang.String PROCESSADMINISTRATORS_PROPERTY
public static java.lang.String PROCESSINSTANCEID_PROPERTY
public static java.lang.String PROCESSINSTANCENAME_PROPERTY
public static java.lang.String PROCESSTEMPLATEID_PROPERTY
public static java.lang.String PROCESSTEMPLATENAME_PROPERTY
public static java.lang.String STARTTIME_PROPERTY
public static java.lang.String UNHANDLEDEXCEPTION_PROPERTY
Constructor Detail |
public ActivityInstanceBean(com.ibm.bpe.api.ActivityInstanceData activity, BFMConnection bfmConnection)
ActivityInstanceBean
from an original ActivityInstanceData
object.
activity
- The original data object.bfmConnection
- The connection to the BusinessFlowManagerService API.public ActivityInstanceBean(com.ibm.bpe.api.QueryResultSet resultSet, BFMConnection bfmConnection)
ActivityInstanceBean
from a QueryResultSet
.
resultSet
- The result object of a query.bfmConnection
- The connection to the BusinessFlowManagerService API.Method Detail |
public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name for the property.
public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name for the property.
public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name for the property.locale
- The locale.
public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked.
public java.util.Calendar getActivationTime()
activationTime
.
getActivationTime
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getActivationTime()
public com.ibm.task.api.TKIID getAdminTaskID()
adminTaskID
.
getAdminTaskID
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getAdminTaskID()
public java.lang.String getApplicationName()
applicationName
.
getApplicationName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getApplicationName()
public int[] getAvailableActions()
availableActions
.
getAvailableActions
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getAvailableActions()
public java.util.Calendar getCompletionTime()
completionTime
.
getCompletionTime
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getCompletionTime()
public java.lang.String getCustomProperty(java.lang.String arg)
customProperty
.
getCustomProperty
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getCustomProperty(java.lang.String)
public java.lang.String getDescription()
description
.
getDescription
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getDescription()
public java.lang.String getDisplayName()
displayName
.
getDisplayName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getDisplayName()
public int getExecutionState()
executionState
.
This property may be set by a client application
therefore the local property has precedence over the object's property originally
retrieved from the server.
getExecutionState
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getExecutionState()
public void setExecutionState(int state)
executionState
of the activity.
This may happen for example when an activity was claimed through the BPC Explorer.
ActivityInstanceBean
object and
the ActivityInstanceData
server object may differ
and the object should be refreshed if necessary.
state
- The new state of the activity instance.public java.util.Calendar getExpirationTime()
expirationTime
.
getExpirationTime
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getExpirationTime()
public java.util.List getFaultNames()
faultNames
.
getFaultNames
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getFaultNames()
public com.ibm.bpe.api.AIID getID()
ID
.
getID
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getID()
public java.lang.String getInputMessageTypeName()
inputMessageTypeName
.
getInputMessageTypeName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
inputMessageTypeTypeSystemName
.
getInputMessageTypeTypeSystemName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getInputMessageTypeTypeSystemName()
public int getKind()
kind
.
getKind
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getKind()
public java.util.Calendar getLastModificationTime()
lastModificationTime
.
getLastModificationTime
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getLastModificationTime()
public java.util.Calendar getLastStateChangeTime()
lastStateChangeTime
.
getLastStateChangeTime
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getLastStateChangeTime()
public java.lang.String getName()
name
.
getName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getName()
public java.util.List getNamesOfCustomProperties()
namesOfCustomProperties()
.
getNamesOfCustomProperties
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getNamesOfCustomProperties()
public java.lang.String getOutputMessageTypeName()
outputMessageTypeName
.
getOutputMessageTypeName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
outputMessageTypeTypeSystemName
.
getOutputMessageTypeTypeSystemName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getOutputMessageTypeTypeSystemName()
public java.lang.String getOwner()
owner
.
getOwner
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getOwner()
public com.ibm.bpe.api.StaffResultSet getProcessAdministrators() throws com.ibm.bpe.api.WorkItemManagerException, com.ibm.bpe.api.InvalidLengthException
processAdministrators
.
getProcessAdministrators
in interface com.ibm.bpe.api.ActivityInstanceData
com.ibm.bpe.api.WorkItemManagerException
com.ibm.bpe.api.InvalidLengthException
ActivityInstanceData.getProcessAdministrators()
public com.ibm.bpe.api.PIID getProcessInstanceID()
processInstanceID
.
getProcessInstanceID
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getProcessInstanceID()
public java.lang.String getProcessInstanceName()
processInstanceName
.
getProcessInstanceName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getProcessInstanceName()
public com.ibm.bpe.api.PTID getProcessTemplateID()
processTemplateID
.
getProcessTemplateID
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getProcessTemplateID()
public java.lang.String getProcessTemplateName()
processTemplateName
.
getProcessTemplateName
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getProcessTemplateName()
public java.util.Calendar getStartTime()
startTime
.
getStartTime
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getStartTime()
public com.ibm.task.api.TKIID getTaskID()
taskID
.
getTaskID
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getTaskID()
public com.ibm.bpe.api.ProcessException getUnhandledException()
unhandledException
.
getUnhandledException
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.getUnhandledException()
public boolean isBusinessRelevant()
businessRelevant
.
isBusinessRelevant
in interface com.ibm.bpe.api.ActivityInstanceData
ActivityInstanceData.isBusinessRelevant()
public MessageWrapper getInputMessageWrapper() throws ClientException
ClientException
public MessageWrapper getOutputMessageWrapper() throws ClientException
ClientException
public MessageWrapper getFaultMessageWrapper() throws ClientException
ClientException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |