IBM WebSphere Application ServerTM
Release 8

com.ibm.bpe.clientmodel.bean
Class ActivityInstanceBean

java.lang.Object
  extended by com.ibm.bpe.clientmodel.bean.ActivityInstanceBean
All Implemented Interfaces:
ActivityInstanceData, java.io.Serializable

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:

If a property is not found in the query result set, the property remains empty. Ig the bean accesses an empty property, it must load the missing information from the server.

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.

See Also:
ActivityInstanceData, QueryResultSet, Serialized Form

Field 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
          Uses the property name to determine labels and converters for the "process administrators" property.
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.
 
Fields inherited from interface com.ibm.bpe.api.ActivityInstanceData
INVOKED_INSTANCE_TYPE_CHILD_PROCESS, INVOKED_INSTANCE_TYPE_CHILD_TASK, INVOKED_INSTANCE_TYPE_INLINE_TASK, INVOKED_INSTANCE_TYPE_NOT_SET, KIND_ABSTRACT_TASK, KIND_ASSIGN, KIND_CALL_ACTIVITY, KIND_COMPENSATE, KIND_COMPENSATE_SCOPE, KIND_COMPENSATION_END_EVENT, KIND_COMPENSATION_INTERRUPTING_SUBPROCESS_START_EVENT, KIND_COMPENSATION_THROW_EVENT, KIND_CUSTOM, KIND_EMPTY, KIND_ERROR_END_EVENT, KIND_ERROR_EVENT_SUBPROCESS_ACTIVITY, KIND_ERROR_INTERRUPTING_BOUNDARY_EVENT, KIND_ERROR_INTERRUPTING_SUBPROCESS_START_EVENT, KIND_EVENT_BASED_GATEWAY, KIND_FLOW, KIND_FLOW_END, KIND_FOR_EACH_PARALLEL, KIND_FOR_EACH_PARALLEL_END, KIND_FOR_EACH_SERIAL, KIND_FOR_EACH_SERIAL_END, KIND_INVOKE, KIND_INVOKE_END, KIND_IOR_GATEWAY, KIND_IOR_IN_GATEWAY, KIND_MESSAGE_CATCH_EVENT, KIND_MESSAGE_END_EVENT, KIND_MESSAGE_EVENT_SUBPROCESS_ACTIVITY, KIND_MESSAGE_NONINTERRUPTING_SUBPROCESS_START_EVENT, KIND_MESSAGE_START_EVENT, KIND_MESSAGE_THROW_EVENT, KIND_NONE_END_EVENT, KIND_NONE_START_EVENT, KIND_PARALLEL_GATEWAY, KIND_PICK, KIND_PICK_END, KIND_RECEIVE, KIND_RECEIVE_TASK, KIND_REPEAT_UNTIL, KIND_REPEAT_UNTIL_END, KIND_REPLY, KIND_RETHROW, KIND_SCOPE, KIND_SCOPE_END, KIND_SCRIPT, KIND_SCRIPT_TASK, KIND_SEND_TASK, KIND_SEQUENCE, KIND_SEQUENCE_END, KIND_SERVICE_TASK, KIND_STAFF, KIND_SUBPROCESS_ACTIVITY, KIND_SWITCH, KIND_SWITCH_END, KIND_TERMINATE, KIND_TERMINATE_END_EVENT, KIND_THROW, KIND_TIMER_CATCH_EVENT, KIND_TIMER_EVENT_SUBPROCESS_ACTIVITY, KIND_TIMER_INTERRUPTING_BOUNDARY_EVENT, KIND_TIMER_NONINTERRUPTING_SUBPROCESS_START_EVENT, KIND_USER_TASK, KIND_WAIT, KIND_WHILE, KIND_WHILE_END, KIND_XOR_GATEWAY, 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, STOP_REASON_ACTIVATION_FAILED, STOP_REASON_EXIT_CONDITION_FALSE, STOP_REASON_FOLLOW_ON_NAVIGATION_FAILED, STOP_REASON_IMPLEMENTATION_FAILED, STOP_REASON_UNSPECIFIED, SUB_STATE_EXPIRING, SUB_STATE_FAILING, SUB_STATE_FINISHING, SUB_STATE_NONE, SUB_STATE_RESTARTING, SUB_STATE_SKIPPING
 
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()
          Returns the processAdministrators property.
 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2004, 2010.

See Also:
Constant Field Values

ACTIVATIONTIME_PROPERTY

public static final java.lang.String ACTIVATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "activation time" property.

See Also:
Constant Field Values

APPLICATIONNAME_PROPERTY

public static final java.lang.String APPLICATIONNAME_PROPERTY
Uses the property name to determine labels and converters for the "application name" property.

See Also:
Constant Field Values

AVAILABLEACTIONS_PROPERTY

public static final java.lang.String AVAILABLEACTIONS_PROPERTY
Uses the property name to determine labels and converters for the "available actions" property.

See Also:
Constant Field Values

COMPLETIONTIME_PROPERTY

public static final java.lang.String COMPLETIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "completion time" property.

See Also:
Constant Field Values

CUSTOMPROPERTY_PROPERTY

public static final java.lang.String CUSTOMPROPERTY_PROPERTY
Uses the property name to determine labels and converters for the "custom properties" property.

See Also:
Constant Field Values

CONTINUEONERROR_PROPERTY

public static final java.lang.String CONTINUEONERROR_PROPERTY
Use the property name to determine labels and converters for the continueOnError property.

See Also:
Constant Field Values

DESCRIPTION_PROPERTY

public static final java.lang.String DESCRIPTION_PROPERTY
Uses the property name to determine labels and converters for the "description" property.

See Also:
Constant Field Values

DISPLAYNAME_PROPERTY

public static final java.lang.String DISPLAYNAME_PROPERTY
Uses the property name to determine labels and converters for the "display name" property.

See Also:
Constant Field Values

EXECUTIONSTATE_PROPERTY

public static final java.lang.String EXECUTIONSTATE_PROPERTY
Uses the property name to determine labels and converters for the "execution state" property.

See Also:
Constant Field Values

EXPIRATIONTIME_PROPERTY

public static final java.lang.String EXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "expiration time" property.

See Also:
Constant Field Values

FAULTNAMES_PROPERTY

public static final java.lang.String FAULTNAMES_PROPERTY
Uses the property name to determine labels and converters for the "fault name" property.

See Also:
Constant Field Values

ID_PROPERTY

public static final java.lang.String ID_PROPERTY
Uses the property name to determine labels and converters for the "ID" property.

See Also:
Constant Field Values

INPUTMESSAGETYPENAME_PROPERTY

public static final java.lang.String INPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the "input message type name" property.

See Also:
Constant Field Values

INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated. 
Uses the property name to determine labels and converters for the "input message type system name" property.

See Also:
Constant Field Values

KIND_PROPERTY

public static final java.lang.String KIND_PROPERTY
Uses the property name to determine labels and converters for the "kind" property.

See Also:
Constant Field Values

LASTMODIFICATIONTIME_PROPERTY

public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "last modification time" property.

See Also:
Constant Field Values

LASTSTATECHANGETIME_PROPERTY

public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
Uses the property name to determine labels and converters for the "last state change time" property.

See Also:
Constant Field Values

NAME_PROPERTY

public static final java.lang.String NAME_PROPERTY
Uses the property name to determine labels and converters for the "name" property.

See Also:
Constant Field Values

OUTPUTMESSAGETYPENAME_PROPERTY

public static final java.lang.String OUTPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the "output message type name" property.

See Also:
Constant Field Values

OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated. 
Uses the property name to determine labels and converters for the "output message type system name" property.

See Also:
Constant Field Values

OWNER_PROPERTY

public static final java.lang.String OWNER_PROPERTY
Uses the property name to determine labels and converters for the "owner" property.

See Also:
Constant Field Values

PREVIOUSEXPIRATIONTIME_PROPERTY

public static final java.lang.String PREVIOUSEXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "expiration time" property.

See Also:
Constant Field Values

PROCESSADMINISTRATORS_PROPERTY

public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
Uses the property name to determine labels and converters for the "process administrators" property. admard: since 7.0.0.2 no longer deprecated

See Also:
Constant Field Values

PROCESSINSTANCEID_PROPERTY

public static final java.lang.String PROCESSINSTANCEID_PROPERTY
Uses the property name to determine labels and converters for the "process instance ID" property.

See Also:
Constant Field Values

PROCESSINSTANCENAME_PROPERTY

public static final java.lang.String PROCESSINSTANCENAME_PROPERTY
Uses the property name to determine labels and converters for the "process instance name" property.

See Also:
Constant Field Values

PROCESSTEMPLATEID_PROPERTY

public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
Uses the property name to determine labels and converters for the "process template ID" property.

See Also:
Constant Field Values

PROCESSTEMPLATENAME_PROPERTY

public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
Uses the property name to determine labels and converters for the "process template name" property.

See Also:
Constant Field Values

PROCESSTEMPLATEDISPLAYNAME_PROPERTY

public static final java.lang.String PROCESSTEMPLATEDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the processTemplateDisplayName property.

See Also:
Constant Field Values

STARTTIME_PROPERTY

public static final java.lang.String STARTTIME_PROPERTY
Uses the property name to determine labels and converters for the "start time" property.

See Also:
Constant Field Values

UNHANDLEDEXCEPTION_PROPERTY

public static final java.lang.String UNHANDLEDEXCEPTION_PROPERTY
Uses the property name to determine labels and converters for the "unhandled exception" property.

See Also:
Constant Field Values

STOPREASON_PROPERTY

public static final java.lang.String STOPREASON_PROPERTY
Uses the property name to determine labels and converters for the "stopReason" property.

See Also:
Constant Field Values

SKIPREQUESTED_PROPERTY

public static final java.lang.String SKIPREQUESTED_PROPERTY
Uses the property name to determine labels and converters for the "skipRequested" property.

See Also:
Constant Field Values

SUBSTATE_PROPERTY

public static final java.lang.String SUBSTATE_PROPERTY
Uses the property name to determine labels and converters for the "subState" property.

See Also:
Constant Field Values
Constructor Detail

ActivityInstanceBean

public ActivityInstanceBean(ActivityInstanceData activity,
                            BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from an original ActivityInstanceData object.

Parameters:
activity - The original data object.
bfmConnection - The connection to the BusinessFlowManagerService API.

ActivityInstanceBean

protected ActivityInstanceBean(AIID id,
                               BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from an activity instance id.

Parameters:
id - The activity instance id.
bfmConnection - The connection to the BusinessFlowManagerService API.

ActivityInstanceBean

public ActivityInstanceBean(QueryResultSet resultSet,
                            BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from a QueryResultSet.

Parameters:
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)
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 resource bundle key for the property.

isValid

public static boolean isValid(java.lang.String propertyName)
Checks that the property is valid.

Parameters:
propertyName - The name of the property to be checked.
Returns:
True if the specified propertyName is a known property for an object of this class.

getActivationTime

public java.util.Calendar getActivationTime()
Returns the activationTime property.

Specified by:
getActivationTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getActivationTime()

getAdminTaskID

public TKIID getAdminTaskID()
Returns the adminTaskID property.

Specified by:
getAdminTaskID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getAdminTaskID()

getProcessAdminTaskID

public TKIID getProcessAdminTaskID()
Returns the processAdminTaskID property.

Specified by:
getProcessAdminTaskID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getProcessAdminTaskID()

getInvokedInstanceID

public OID getInvokedInstanceID()
Returns the invokedInstanceID property.

Specified by:
getInvokedInstanceID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getInvokedInstanceID()

getInvokedInstanceType

public int getInvokedInstanceType()
Returns the invokedInstanceType property.

Specified by:
getInvokedInstanceType in interface ActivityInstanceData
See Also:
ActivityInstanceData.getInvokedInstanceType()

getActivityTemplateID

public ATID getActivityTemplateID()
Returns the activityTemplateID property.

Specified by:
getActivityTemplateID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getActivityTemplateID()

getApplicationName

public java.lang.String getApplicationName()
Returns the applicationName property.

Specified by:
getApplicationName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getApplicationName()

getAvailableActions

public int[] getAvailableActions()
Returns the availableActions property.

Specified by:
getAvailableActions in interface ActivityInstanceData
See Also:
ActivityInstanceData.getAvailableActions()

getCompletionTime

public java.util.Calendar getCompletionTime()
Returns the completionTime property.

Specified by:
getCompletionTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getCompletionTime()

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String arg)
Returns the customProperty property.

Specified by:
getCustomProperty in interface ActivityInstanceData
Parameters:
arg - The name of the custom property for which the value is to be read.
See Also:
ActivityInstanceData.getCustomProperty(java.lang.String)

getDescription

public java.lang.String getDescription()
Returns the description property.

Specified by:
getDescription in interface ActivityInstanceData
See Also:
ActivityInstanceData.getDescription()

getDisplayName

public java.lang.String getDisplayName()
Returns the displayName property.

Specified by:
getDisplayName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getDisplayName()

getExecutionState

public int getExecutionState()
Returns the 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.

Specified by:
getExecutionState in interface ActivityInstanceData
See Also:
ActivityInstanceData.getExecutionState()

setExecutionState

public void setExecutionState(int state)
Changes the activity's 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.

Parameters:
state - The new state of the activity instance.

getExpirationTime

public java.util.Calendar getExpirationTime()
Returns the expirationTime property.

Specified by:
getExpirationTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getExpirationTime()

getFaultNames

public java.util.List getFaultNames()
Returns the faultNames property.

Specified by:
getFaultNames in interface ActivityInstanceData
See Also:
ActivityInstanceData.getFaultNames()

getID

public AIID getID()
Returns the ID property.

Specified by:
getID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getID()

getInputMessageTypeName

public java.lang.String getInputMessageTypeName()
Returns the inputMessageTypeName property.

Specified by:
getInputMessageTypeName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getInputMessageTypeName()

getInputMessageTypeTypeSystemName

public java.lang.String getInputMessageTypeTypeSystemName()
Deprecated. 

Returns the inputMessageTypeTypeSystemName property.

Specified by:
getInputMessageTypeTypeSystemName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getInputMessageTypeTypeSystemName()

getKind

public int getKind()
Returns the kind property.

Specified by:
getKind in interface ActivityInstanceData
See Also:
ActivityInstanceData.getKind()

getLastModificationTime

public java.util.Calendar getLastModificationTime()
Returns the lastModificationTime property.

Specified by:
getLastModificationTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getLastModificationTime()

getLastStateChangeTime

public java.util.Calendar getLastStateChangeTime()
Returns the lastStateChangeTime property.

Specified by:
getLastStateChangeTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getLastStateChangeTime()

getName

public java.lang.String getName()
Returns the name property.

Specified by:
getName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getName()

getNamesOfCustomProperties

public java.util.List getNamesOfCustomProperties()
Returns the namesOfCustomProperties() property.

Specified by:
getNamesOfCustomProperties in interface ActivityInstanceData
See Also:
ActivityInstanceData.getNamesOfCustomProperties()

getOutputMessageTypeName

public java.lang.String getOutputMessageTypeName()
Returns the outputMessageTypeName property.

Specified by:
getOutputMessageTypeName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getOutputMessageTypeName()

getOutputMessageTypeTypeSystemName

public java.lang.String getOutputMessageTypeTypeSystemName()
Deprecated. 

Returns the outputMessageTypeTypeSystemName property.

Specified by:
getOutputMessageTypeTypeSystemName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getOutputMessageTypeTypeSystemName()

getOwner

public java.lang.String getOwner()
Returns the owner property.

Specified by:
getOwner in interface ActivityInstanceData
See Also:
ActivityInstanceData.getOwner()

getProcessAdministrators

public StaffResultSet getProcessAdministrators()
                                        throws WorkItemManagerException,
                                               InvalidLengthException
Returns the processAdministrators property.

Specified by:
getProcessAdministrators in interface ActivityInstanceData
Throws:
WorkItemManagerException
InvalidLengthException
See Also:
admard: since 7.0.0.2 no longer deprecated

getProcessInstanceID

public PIID getProcessInstanceID()
Returns the processInstanceID property.

Specified by:
getProcessInstanceID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getProcessInstanceID()

getProcessInstanceName

public java.lang.String getProcessInstanceName()
Returns the processInstanceName property.

Specified by:
getProcessInstanceName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getProcessInstanceName()

getProcessTemplateID

public PTID getProcessTemplateID()
Returns the processTemplateID property.

Specified by:
getProcessTemplateID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getProcessTemplateID()

getProcessTemplateName

public java.lang.String getProcessTemplateName()
Returns the processTemplateName property.

Specified by:
getProcessTemplateName in interface ActivityInstanceData
See Also:
ActivityInstanceData.getProcessTemplateName()

getProcessTemplateDisplayName

public java.lang.String getProcessTemplateDisplayName()
Returns the processTemplateDisplayName property. Returns the processTemplateName property when a display name is not assigned.


getStartTime

public java.util.Calendar getStartTime()
Returns the startTime property.

Specified by:
getStartTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getStartTime()

getTaskID

public TKIID getTaskID()
Returns the taskID property.

Specified by:
getTaskID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getTaskID()

getScopeID

public com.ibm.bpe.api.SIID getScopeID()
Returns the scopeID property.

Specified by:
getScopeID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getScopeID()

getScopeTemplateID

public com.ibm.bpe.api.STID getScopeTemplateID()
Returns the scopeTemplateID property.

Specified by:
getScopeTemplateID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getScopeTemplateID()

getEventHandlerInstanceID

public com.ibm.bpe.api.EHIID getEventHandlerInstanceID()
Returns the eventHandlerInstanceID property.

Specified by:
getEventHandlerInstanceID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getEventHandlerInstanceID()

getEnclosingForEachID

public com.ibm.bpe.api.FEIID getEnclosingForEachID()
Returns the enclosingForEachID property.

Specified by:
getEnclosingForEachID in interface ActivityInstanceData
See Also:
ActivityInstanceData.getEnclosingForEachID()

getUnhandledException

public ProcessException getUnhandledException()
Returns the unhandledException property.

Specified by:
getUnhandledException in interface ActivityInstanceData
See Also:
ActivityInstanceData.getUnhandledException()

getStopReason

public int getStopReason()
Returns the stopReason property.

Specified by:
getStopReason in interface ActivityInstanceData
See Also:
ActivityInstanceData.getStopReason()

getSubState

public int getSubState()
Returns the subState property.

Specified by:
getSubState in interface ActivityInstanceData
See Also:
ActivityInstanceData.getSubState()

isBusinessRelevant

public boolean isBusinessRelevant()
Returns the businessRelevant property.

Specified by:
isBusinessRelevant in interface ActivityInstanceData
See Also:
ActivityInstanceData.isBusinessRelevant()

getActivityClaimed

public boolean getActivityClaimed()
Returns true if executionState is of state CLAIMED, returns false otherwise


getInputMessageWrapper

public MessageWrapper getInputMessageWrapper()
                                      throws ClientException
Retrieves the input message.

Returns:
The wrapped message.
Throws:
ClientException

getOutputMessageWrapper

public MessageWrapper getOutputMessageWrapper()
                                       throws ClientException
Retrieves the output message.

Returns:
The wrapped message.
Throws:
ClientException

getFaultMessageWrapper

public MessageWrapper getFaultMessageWrapper()
                                      throws ClientException
Retrieves the fault message.

Returns:
The wrapped message.
Throws:
ClientException

isSkipRequested

public boolean isSkipRequested()
Returns the skipRequested property.

Specified by:
isSkipRequested in interface ActivityInstanceData
See Also:
ActivityInstanceData.isSkipRequested()

isContinueOnError

public boolean isContinueOnError()
Returns the continueOnError property.

Specified by:
isContinueOnError in interface ActivityInstanceData
See Also:
ActivityInstanceData.isContinueOnError()

getPreviousExpirationTime

public java.util.Calendar getPreviousExpirationTime()
Returns the time the activity instance expired for the first time. Returns null when the activity did not expire.

Specified by:
getPreviousExpirationTime in interface ActivityInstanceData
See Also:
ActivityInstanceData.getPreviousExpirationTime()

IBM WebSphere Application ServerTM
Release 8