|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.clientmodel.bean.ActivityInstanceBean
public class 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 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.
ActivityInstanceData
,
QueryResultSet
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ACTIVATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "activation time" property. |
static java.lang.String |
APPLICATIONNAME_PROPERTY
Uses the property name to determine labels and converters for the "application name" property. |
static java.lang.String |
AVAILABLEACTIONS_PROPERTY
Uses the property name to determine labels and converters for the "available actions" property. |
static java.lang.String |
COMPLETIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "completion time" property. |
static java.lang.String |
CONTINUEONERROR_PROPERTY
Use the property name to determine labels and converters for the continueOnError property. |
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2004, 2010. |
static java.lang.String |
CUSTOMPROPERTY_PROPERTY
Uses the property name to determine labels and converters for the "custom properties" property. |
static java.lang.String |
DESCRIPTION_PROPERTY
Uses the property name to determine labels and converters for the "description" property. |
static java.lang.String |
DISPLAYNAME_PROPERTY
Uses the property name to determine labels and converters for the "display name" property. |
static java.lang.String |
EXECUTIONSTATE_PROPERTY
Uses the property name to determine labels and converters for the "execution state" property. |
static java.lang.String |
EXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "expiration time" property. |
static java.lang.String |
FAULTNAMES_PROPERTY
Uses the property name to determine labels and converters for the "fault name" property. |
static java.lang.String |
ID_PROPERTY
Uses the property name to determine labels and converters for the "ID" property. |
static java.lang.String |
INPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the "input message type name" property. |
static java.lang.String |
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated. |
static java.lang.String |
KIND_PROPERTY
Uses the property name to determine labels and converters for the "kind" property. |
static java.lang.String |
LASTMODIFICATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "last modification time" property. |
static java.lang.String |
LASTSTATECHANGETIME_PROPERTY
Uses the property name to determine labels and converters for the "last state change time" property. |
static java.lang.String |
NAME_PROPERTY
Uses the property name to determine labels and converters for the "name" property. |
static java.lang.String |
OUTPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the "output message type name" property. |
static java.lang.String |
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated. |
static java.lang.String |
OWNER_PROPERTY
Uses the property name to determine labels and converters for the "owner" property. |
static java.lang.String |
PREVIOUSEXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "expiration time" property. |
static java.lang.String |
PROCESSADMINISTRATORS_PROPERTY
Deprecated. |
static java.lang.String |
PROCESSINSTANCEID_PROPERTY
Uses the property name to determine labels and converters for the "process instance ID" property. |
static java.lang.String |
PROCESSINSTANCENAME_PROPERTY
Uses the property name to determine labels and converters for the "process instance name" property. |
static java.lang.String |
PROCESSTEMPLATEDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the processTemplateDisplayName property. |
static java.lang.String |
PROCESSTEMPLATEID_PROPERTY
Uses the property name to determine labels and converters for the "process template ID" property. |
static java.lang.String |
PROCESSTEMPLATENAME_PROPERTY
Uses the property name to determine labels and converters for the "process template name" property. |
static java.lang.String |
SKIPREQUESTED_PROPERTY
Uses the property name to determine labels and converters for the "skipRequested" property. |
static java.lang.String |
STARTTIME_PROPERTY
Uses the property name to determine labels and converters for the "start time" property. |
static java.lang.String |
STOPREASON_PROPERTY
Uses the property name to determine labels and converters for the "stopReason" property. |
static java.lang.String |
SUBSTATE_PROPERTY
Uses the property name to determine labels and converters for the "subState" property. |
static java.lang.String |
UNHANDLEDEXCEPTION_PROPERTY
Uses the property name to determine labels and converters for the "unhandled exception" property. |
Constructor Summary | |
---|---|
|
ActivityInstanceBean(ActivityInstanceData activity,
BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from an original
ActivityInstanceData object. |
protected |
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 | |
---|---|
java.util.Calendar |
getActivationTime()
Returns the activationTime property. |
boolean |
getActivityClaimed()
Returns true if executionState is of state CLAIMED, returns
false otherwise |
ATID |
getActivityTemplateID()
Returns the activityTemplateID property. |
TKIID |
getAdminTaskID()
Returns the adminTaskID property. |
java.lang.String |
getApplicationName()
Returns the applicationName property. |
int[] |
getAvailableActions()
Returns the availableActions property. |
java.util.Calendar |
getCompletionTime()
Returns the completionTime property. |
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 customProperty property. |
java.lang.String |
getDescription()
Returns the description property. |
java.lang.String |
getDisplayName()
Returns the displayName property. |
com.ibm.bpe.api.FEIID |
getEnclosingForEachID()
Returns the enclosingForEachID property. |
com.ibm.bpe.api.EHIID |
getEventHandlerInstanceID()
Returns the eventHandlerInstanceID property. |
int |
getExecutionState()
Returns the executionState property. |
java.util.Calendar |
getExpirationTime()
Returns the expirationTime property. |
MessageWrapper |
getFaultMessageWrapper()
Retrieves the fault message. |
java.util.List |
getFaultNames()
Returns the faultNames property. |
AIID |
getID()
Returns the ID property. |
java.lang.String |
getInputMessageTypeName()
Returns the inputMessageTypeName property. |
java.lang.String |
getInputMessageTypeTypeSystemName()
Deprecated. |
MessageWrapper |
getInputMessageWrapper()
Retrieves the input message. |
OID |
getInvokedInstanceID()
Returns the invokedInstanceID property. |
int |
getInvokedInstanceType()
Returns the invokedInstanceType property. |
int |
getKind()
Returns the kind 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.Calendar |
getLastModificationTime()
Returns the lastModificationTime property. |
java.util.Calendar |
getLastStateChangeTime()
Returns the lastStateChangeTime property. |
java.lang.String |
getName()
Returns the name property. |
java.util.List |
getNamesOfCustomProperties()
Returns the namesOfCustomProperties() property. |
java.lang.String |
getOutputMessageTypeName()
Returns the outputMessageTypeName property. |
java.lang.String |
getOutputMessageTypeTypeSystemName()
Deprecated. |
MessageWrapper |
getOutputMessageWrapper()
Retrieves the output message. |
java.lang.String |
getOwner()
Returns the owner property. |
java.util.Calendar |
getPreviousExpirationTime()
Returns the time the activity instance expired for the first time. |
StaffResultSet |
getProcessAdministrators()
Deprecated. |
TKIID |
getProcessAdminTaskID()
Returns the processAdminTaskID property. |
PIID |
getProcessInstanceID()
Returns the processInstanceID property. |
java.lang.String |
getProcessInstanceName()
Returns the processInstanceName property. |
java.lang.String |
getProcessTemplateDisplayName()
Returns the processTemplateDisplayName property. |
PTID |
getProcessTemplateID()
Returns the processTemplateID property. |
java.lang.String |
getProcessTemplateName()
Returns the processTemplateName property. |
com.ibm.bpe.api.SIID |
getScopeID()
Returns the scopeID property. |
com.ibm.bpe.api.STID |
getScopeTemplateID()
Returns the scopeTemplateID property. |
java.util.Calendar |
getStartTime()
Returns the startTime property. |
int |
getStopReason()
Returns the stopReason property. |
int |
getSubState()
Returns the subState property. |
TKIID |
getTaskID()
Returns the taskID property. |
ProcessException |
getUnhandledException()
Returns the unhandledException property. |
boolean |
isBusinessRelevant()
Returns the businessRelevant property. |
boolean |
isContinueOnError()
Returns the continueOnError property. |
boolean |
isSkipRequested()
Returns the skipRequested property. |
static boolean |
isValid(java.lang.String propertyName)
Checks that the property is valid. |
void |
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 |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String ACTIVATIONTIME_PROPERTY
public static final java.lang.String APPLICATIONNAME_PROPERTY
public static final java.lang.String AVAILABLEACTIONS_PROPERTY
public static final java.lang.String COMPLETIONTIME_PROPERTY
public static final java.lang.String CUSTOMPROPERTY_PROPERTY
public static final java.lang.String CONTINUEONERROR_PROPERTY
continueOnError
property.
public static final java.lang.String DESCRIPTION_PROPERTY
public static final java.lang.String DISPLAYNAME_PROPERTY
public static final java.lang.String EXECUTIONSTATE_PROPERTY
public static final java.lang.String EXPIRATIONTIME_PROPERTY
public static final java.lang.String FAULTNAMES_PROPERTY
public static final java.lang.String ID_PROPERTY
public static final java.lang.String INPUTMESSAGETYPENAME_PROPERTY
public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
public static final java.lang.String KIND_PROPERTY
public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
public static final java.lang.String NAME_PROPERTY
public static final java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
public static final java.lang.String OWNER_PROPERTY
public static final java.lang.String PREVIOUSEXPIRATIONTIME_PROPERTY
public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
public static final java.lang.String PROCESSINSTANCEID_PROPERTY
public static final java.lang.String PROCESSINSTANCENAME_PROPERTY
public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
public static final java.lang.String PROCESSTEMPLATEDISPLAYNAME_PROPERTY
processTemplateDisplayName
property.
public static final java.lang.String STARTTIME_PROPERTY
public static final java.lang.String UNHANDLEDEXCEPTION_PROPERTY
public static final java.lang.String STOPREASON_PROPERTY
public static final java.lang.String SKIPREQUESTED_PROPERTY
public static final java.lang.String SUBSTATE_PROPERTY
Constructor Detail |
---|
public ActivityInstanceBean(ActivityInstanceData activity, BFMConnection bfmConnection)
ActivityInstanceBean
from an original
ActivityInstanceData
object.
activity
- The original data object.bfmConnection
- The connection to the BusinessFlowManagerService API.protected ActivityInstanceBean(AIID id, BFMConnection bfmConnection)
ActivityInstanceBean
from an activity
instance id.
id
- The activity instance id.bfmConnection
- The connection to the BusinessFlowManagerService API.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 |
---|
public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name of the property.
propertyName
. Null otherwise.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.
propertyName
is a known
property for an object of this class.public java.util.Calendar getActivationTime()
activationTime
property.
getActivationTime
in interface ActivityInstanceData
ActivityInstanceData.getActivationTime()
public TKIID getAdminTaskID()
adminTaskID
property.
getAdminTaskID
in interface ActivityInstanceData
ActivityInstanceData.getAdminTaskID()
public TKIID getProcessAdminTaskID()
processAdminTaskID
property.
getProcessAdminTaskID
in interface ActivityInstanceData
ActivityInstanceData.getProcessAdminTaskID()
public OID getInvokedInstanceID()
invokedInstanceID
property.
getInvokedInstanceID
in interface ActivityInstanceData
ActivityInstanceData.getInvokedInstanceID()
public int getInvokedInstanceType()
invokedInstanceType
property.
getInvokedInstanceType
in interface ActivityInstanceData
ActivityInstanceData.getInvokedInstanceType()
public ATID getActivityTemplateID()
activityTemplateID
property.
getActivityTemplateID
in interface ActivityInstanceData
ActivityInstanceData.getActivityTemplateID()
public java.lang.String getApplicationName()
applicationName
property.
getApplicationName
in interface ActivityInstanceData
ActivityInstanceData.getApplicationName()
public int[] getAvailableActions()
availableActions
property.
getAvailableActions
in interface ActivityInstanceData
ActivityInstanceData.getAvailableActions()
public java.util.Calendar getCompletionTime()
completionTime
property.
getCompletionTime
in interface ActivityInstanceData
ActivityInstanceData.getCompletionTime()
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.ActivityInstanceData.getCustomProperty(java.lang.String)
public java.lang.String getDescription()
description
property.
getDescription
in interface ActivityInstanceData
ActivityInstanceData.getDescription()
public java.lang.String getDisplayName()
displayName
property.
getDisplayName
in interface ActivityInstanceData
ActivityInstanceData.getDisplayName()
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
ActivityInstanceData.getExecutionState()
public void setExecutionState(int state)
executionState
property. This can
happen, for example, when an activity was claimed through the Business
Process Choreographer Explorer. 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.public java.util.Calendar getExpirationTime()
expirationTime
property.
getExpirationTime
in interface ActivityInstanceData
ActivityInstanceData.getExpirationTime()
public java.util.List getFaultNames()
faultNames
property.
getFaultNames
in interface ActivityInstanceData
ActivityInstanceData.getFaultNames()
public AIID getID()
ID
property.
getID
in interface ActivityInstanceData
ActivityInstanceData.getID()
public java.lang.String getInputMessageTypeName()
inputMessageTypeName
property.
getInputMessageTypeName
in interface ActivityInstanceData
ActivityInstanceData.getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
inputMessageTypeTypeSystemName
property.
getInputMessageTypeTypeSystemName
in interface ActivityInstanceData
ActivityInstanceData.getInputMessageTypeTypeSystemName()
public int getKind()
kind
property.
getKind
in interface ActivityInstanceData
ActivityInstanceData.getKind()
public java.util.Calendar getLastModificationTime()
lastModificationTime
property.
getLastModificationTime
in interface ActivityInstanceData
ActivityInstanceData.getLastModificationTime()
public java.util.Calendar getLastStateChangeTime()
lastStateChangeTime
property.
getLastStateChangeTime
in interface ActivityInstanceData
ActivityInstanceData.getLastStateChangeTime()
public java.lang.String getName()
name
property.
getName
in interface ActivityInstanceData
ActivityInstanceData.getName()
public java.util.List getNamesOfCustomProperties()
namesOfCustomProperties()
property.
getNamesOfCustomProperties
in interface ActivityInstanceData
ActivityInstanceData.getNamesOfCustomProperties()
public java.lang.String getOutputMessageTypeName()
outputMessageTypeName
property.
getOutputMessageTypeName
in interface ActivityInstanceData
ActivityInstanceData.getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
outputMessageTypeTypeSystemName
property.
getOutputMessageTypeTypeSystemName
in interface ActivityInstanceData
ActivityInstanceData.getOutputMessageTypeTypeSystemName()
public java.lang.String getOwner()
owner
property.
getOwner
in interface ActivityInstanceData
ActivityInstanceData.getOwner()
public StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
processAdministrators
property.
getProcessAdministrators
in interface ActivityInstanceData
WorkItemManagerException
InvalidLengthException
ActivityInstanceData.getProcessAdministrators()
public PIID getProcessInstanceID()
processInstanceID
property.
getProcessInstanceID
in interface ActivityInstanceData
ActivityInstanceData.getProcessInstanceID()
public java.lang.String getProcessInstanceName()
processInstanceName
property.
getProcessInstanceName
in interface ActivityInstanceData
ActivityInstanceData.getProcessInstanceName()
public PTID getProcessTemplateID()
processTemplateID
property.
getProcessTemplateID
in interface ActivityInstanceData
ActivityInstanceData.getProcessTemplateID()
public java.lang.String getProcessTemplateName()
processTemplateName
property.
getProcessTemplateName
in interface ActivityInstanceData
ActivityInstanceData.getProcessTemplateName()
public java.lang.String getProcessTemplateDisplayName()
processTemplateDisplayName
property. Returns the
processTemplateName
property when a display name is not
assigned.
public java.util.Calendar getStartTime()
startTime
property.
getStartTime
in interface ActivityInstanceData
ActivityInstanceData.getStartTime()
public TKIID getTaskID()
taskID
property.
getTaskID
in interface ActivityInstanceData
ActivityInstanceData.getTaskID()
public com.ibm.bpe.api.SIID getScopeID()
scopeID
property.
getScopeID
in interface ActivityInstanceData
ActivityInstanceData.getScopeID()
public com.ibm.bpe.api.STID getScopeTemplateID()
scopeTemplateID
property.
getScopeTemplateID
in interface ActivityInstanceData
ActivityInstanceData.getScopeTemplateID()
public com.ibm.bpe.api.EHIID getEventHandlerInstanceID()
eventHandlerInstanceID
property.
getEventHandlerInstanceID
in interface ActivityInstanceData
ActivityInstanceData.getEventHandlerInstanceID()
public com.ibm.bpe.api.FEIID getEnclosingForEachID()
enclosingForEachID
property.
getEnclosingForEachID
in interface ActivityInstanceData
ActivityInstanceData.getEnclosingForEachID()
public ProcessException getUnhandledException()
unhandledException
property.
getUnhandledException
in interface ActivityInstanceData
ActivityInstanceData.getUnhandledException()
public int getStopReason()
stopReason
property.
getStopReason
in interface ActivityInstanceData
ActivityInstanceData.getStopReason()
public int getSubState()
subState
property.
getSubState
in interface ActivityInstanceData
ActivityInstanceData.getSubState()
public boolean isBusinessRelevant()
businessRelevant
property.
isBusinessRelevant
in interface ActivityInstanceData
ActivityInstanceData.isBusinessRelevant()
public boolean getActivityClaimed()
executionState
is of state CLAIMED, returns
false otherwise
public MessageWrapper getInputMessageWrapper() throws ClientException
ClientException
public MessageWrapper getOutputMessageWrapper() throws ClientException
ClientException
public MessageWrapper getFaultMessageWrapper() throws ClientException
ClientException
public boolean isSkipRequested()
skipRequested
property.
isSkipRequested
in interface ActivityInstanceData
ActivityInstanceData.isSkipRequested()
public boolean isContinueOnError()
continueOnError
property.
isContinueOnError
in interface ActivityInstanceData
ActivityInstanceData.isContinueOnError()
public java.util.Calendar getPreviousExpirationTime()
getPreviousExpirationTime
in interface ActivityInstanceData
ActivityInstanceData.getPreviousExpirationTime()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |