com.ibm.bpe.clientmodel.bean

Class ActivityInstanceBean

  1. java.lang.Object
  2. extended bycom.ibm.bpe.clientmodel.bean.ActivityInstanceBean
All implemented interfaces:
ActivityInstanceData, java.io.Serializable

  1. public class ActivityInstanceBean
  2. extends java.lang.Object
  3. 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

Modifier and Type Field and Description
  1. static
  2. java.lang.String
ACTIVATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "activation time" property.
  1. static
  2. java.lang.String
APPLICATIONNAME_PROPERTY
Uses the property name to determine labels and converters for the "application name" property.
  1. static
  2. java.lang.String
AVAILABLEACTIONS_PROPERTY
Uses the property name to determine labels and converters for the "available actions" property.
  1. static
  2. java.lang.String
COMPLETIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "completion time" property.
  1. static
  2. java.lang.String
CONTINUEONERROR_PROPERTY
Use the property name to determine labels and converters for the continueOnError property.
  1. static
  2. java.lang.String
COPYRIGHT
(C) Copyright IBM Corporation 2004, 2010.
  1. static
  2. java.lang.String
CUSTOMPROPERTY_PROPERTY
Uses the property name to determine labels and converters for the "custom properties" property.
  1. static
  2. java.lang.String
DESCRIPTION_PROPERTY
Uses the property name to determine labels and converters for the "description" property.
  1. static
  2. java.lang.String
DISPLAYNAME_PROPERTY
Uses the property name to determine labels and converters for the "display name" property.
  1. static
  2. java.lang.String
EXECUTIONSTATE_PROPERTY
Uses the property name to determine labels and converters for the "execution state" property.
  1. static
  2. java.lang.String
EXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "expiration time" property.
  1. static
  2. java.lang.String
FAULTNAMES_PROPERTY
Uses the property name to determine labels and converters for the "fault name" property.
  1. static
  2. java.lang.String
ID_PROPERTY
Uses the property name to determine labels and converters for the "ID" property.
  1. static
  2. java.lang.String
INPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the "input message type name" property.
  1. static
  2. java.lang.String
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
  1. static
  2. java.lang.String
KIND_PROPERTY
Uses the property name to determine labels and converters for the "kind" property.
  1. static
  2. java.lang.String
LASTMODIFICATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "last modification time" property.
  1. static
  2. java.lang.String
LASTSTATECHANGETIME_PROPERTY
Uses the property name to determine labels and converters for the "last state change time" property.
  1. static
  2. java.lang.String
NAME_PROPERTY
Uses the property name to determine labels and converters for the "name" property.
  1. static
  2. java.lang.String
OUTPUTMESSAGETYPENAME_PROPERTY
Uses the property name to determine labels and converters for the "output message type name" property.
  1. static
  2. java.lang.String
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
  1. static
  2. java.lang.String
OWNER_PROPERTY
Uses the property name to determine labels and converters for the "owner" property.
  1. static
  2. java.lang.String
PREVIOUSEXPIRATIONTIME_PROPERTY
Uses the property name to determine labels and converters for the "expiration time" property.
  1. static
  2. java.lang.String
PROCESSADMINISTRATORS_PROPERTY
Uses the property name to determine labels and converters for the "process administrators" property.
  1. static
  2. java.lang.String
PROCESSINSTANCEID_PROPERTY
Uses the property name to determine labels and converters for the "process instance ID" property.
  1. static
  2. java.lang.String
PROCESSINSTANCENAME_PROPERTY
Uses the property name to determine labels and converters for the "process instance name" property.
  1. static
  2. java.lang.String
PROCESSTEMPLATEDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the processTemplateDisplayName property.
  1. static
  2. java.lang.String
PROCESSTEMPLATEID_PROPERTY
Uses the property name to determine labels and converters for the "process template ID" property.
  1. static
  2. java.lang.String
PROCESSTEMPLATENAME_PROPERTY
Uses the property name to determine labels and converters for the "process template name" property.
  1. static
  2. java.lang.String
SKIPREQUESTED_PROPERTY
Uses the property name to determine labels and converters for the "skipRequested" property.
  1. static
  2. java.lang.String
STARTTIME_PROPERTY
Uses the property name to determine labels and converters for the "start time" property.
  1. static
  2. java.lang.String
STOPREASON_PROPERTY
Uses the property name to determine labels and converters for the "stopReason" property.
  1. static
  2. java.lang.String
SUBSTATE_PROPERTY
Uses the property name to determine labels and converters for the "subState" property.
  1. static
  2. 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

Modifier Constructor and Description
  1. (package private)
ActivityInstanceBean(ActivityInstanceData activity,BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from an original ActivityInstanceData object.
  1. protected
ActivityInstanceBean(AIID id,BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from an activity instance id.
  1. (package private)
ActivityInstanceBean(QueryResultSet resultSet,BFMConnection bfmConnection)
Constructs a new ActivityInstanceBean from a QueryResultSet.

Method Summary

Modifier and Type Method and Description
  1. java.util.Calendar
getActivationTime()
Returns the activationTime property.
  1. boolean
getActivityClaimed()
Returns true if executionState is of state CLAIMED, returns false otherwise
  1. ATID
getActivityTemplateID()
Returns the activityTemplateID property.
  1. TKIID
getAdminTaskID()
Returns the adminTaskID property.
  1. java.lang.String
getApplicationName()
Returns the applicationName property.
  1. int[]
getAvailableActions()
Returns the availableActions property.
  1. java.util.Calendar
getCompletionTime()
Returns the completionTime property.
  1. static
  2. SimpleConverter
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
  1. java.lang.String
getCustomProperty(java.lang.String arg)
Returns the customProperty property.
  1. java.lang.String
getDescription()
Returns the description property.
  1. java.lang.String
getDisplayName()
Returns the displayName property.
  1. com.ibm.bpe.api.FEIID
getEnclosingForEachID()
Returns the enclosingForEachID property.
  1. com.ibm.bpe.api.EHIID
getEventHandlerInstanceID()
Returns the eventHandlerInstanceID property.
  1. int
getExecutionState()
Returns the executionState property.
  1. java.util.Calendar
getExpirationTime()
Returns the expirationTime property.
  1. MessageWrapper
getFaultMessageWrapper()
Retrieves the fault message.
  1. java.util.List
getFaultNames()
Returns the faultNames property.
  1. AIID
getID()
Returns the ID property.
  1. java.lang.String
getInputMessageTypeName()
Returns the inputMessageTypeName property.
  1. java.lang.String
getInputMessageTypeTypeSystemName()
Deprecated.
  1. MessageWrapper
getInputMessageWrapper()
Retrieves the input message.
  1. OID
getInvokedInstanceID()
Returns the invokedInstanceID property.
  1. int
getInvokedInstanceType()
Returns the invokedInstanceType property.
  1. int
getKind()
Returns the kind property.
  1. static
  2. java.lang.String
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property.
  1. static
  2. java.lang.String
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label of a property from the resource bundle.
  1. java.util.Calendar
getLastModificationTime()
Returns the lastModificationTime property.
  1. java.util.Calendar
getLastStateChangeTime()
Returns the lastStateChangeTime property.
  1. java.lang.String
getName()
Returns the name property.
  1. java.util.List
getNamesOfCustomProperties()
Returns the namesOfCustomProperties() property.
  1. java.lang.String
getOutputMessageTypeName()
Returns the outputMessageTypeName property.
  1. java.lang.String
getOutputMessageTypeTypeSystemName()
Deprecated.
  1. MessageWrapper
getOutputMessageWrapper()
Retrieves the output message.
  1. java.lang.String
getOwner()
Returns the owner property.
  1. java.util.Calendar
getPreviousExpirationTime()
Returns the time the activity instance expired for the first time.
  1. StaffResultSet
getProcessAdministrators()
Returns the processAdministrators property.
  1. TKIID
getProcessAdminTaskID()
Returns the processAdminTaskID property.
  1. PIID
getProcessInstanceID()
Returns the processInstanceID property.
  1. java.lang.String
getProcessInstanceName()
Returns the processInstanceName property.
  1. java.lang.String
getProcessTemplateDisplayName()
Returns the processTemplateDisplayName property.
  1. PTID
getProcessTemplateID()
Returns the processTemplateID property.
  1. java.lang.String
getProcessTemplateName()
Returns the processTemplateName property.
  1. com.ibm.bpe.api.SIID
getScopeID()
Returns the scopeID property.
  1. com.ibm.bpe.api.STID
getScopeTemplateID()
Returns the scopeTemplateID property.
  1. java.util.Calendar
getStartTime()
Returns the startTime property.
  1. int
getStopReason()
Returns the stopReason property.
  1. int
getSubState()
Returns the subState property.
  1. TKIID
getTaskID()
Returns the taskID property.
  1. ProcessException
getUnhandledException()
Returns the unhandledException property.
  1. boolean
isBusinessRelevant()
Returns the businessRelevant property.
  1. boolean
isContinueOnError()
Returns the continueOnError property.
  1. boolean
isSkipRequested()
Returns the skipRequested property.
  1. static
  2. boolean
isValid(java.lang.String propertyName)
Checks that the property is valid.
  1. 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

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

ACTIVATIONTIME_PROPERTY

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

APPLICATIONNAME_PROPERTY

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

AVAILABLEACTIONS_PROPERTY

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

COMPLETIONTIME_PROPERTY

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

CUSTOMPROPERTY_PROPERTY

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

CONTINUEONERROR_PROPERTY

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

DESCRIPTION_PROPERTY

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

DISPLAYNAME_PROPERTY

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

EXECUTIONSTATE_PROPERTY

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

EXPIRATIONTIME_PROPERTY

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

FAULTNAMES_PROPERTY

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

ID_PROPERTY

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

INPUTMESSAGETYPENAME_PROPERTY

  1. 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:

INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

  1. 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:

KIND_PROPERTY

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

LASTMODIFICATIONTIME_PROPERTY

  1. 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:

LASTSTATECHANGETIME_PROPERTY

  1. 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:

NAME_PROPERTY

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

OUTPUTMESSAGETYPENAME_PROPERTY

  1. 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:

OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

  1. 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:

OWNER_PROPERTY

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

PREVIOUSEXPIRATIONTIME_PROPERTY

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

PROCESSADMINISTRATORS_PROPERTY

  1. 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:

PROCESSINSTANCEID_PROPERTY

  1. 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:

PROCESSINSTANCENAME_PROPERTY

  1. 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:

PROCESSTEMPLATEID_PROPERTY

  1. 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:

PROCESSTEMPLATENAME_PROPERTY

  1. 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:

PROCESSTEMPLATEDISPLAYNAME_PROPERTY

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

STARTTIME_PROPERTY

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

UNHANDLEDEXCEPTION_PROPERTY

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

STOPREASON_PROPERTY

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

SKIPREQUESTED_PROPERTY

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

SUBSTATE_PROPERTY

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

Constructor Detail

ActivityInstanceBean

  1. public ActivityInstanceBean(ActivityInstanceData activity,
  2. 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

  1. protected ActivityInstanceBean( AIID id,
  2. 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

  1. public ActivityInstanceBean(QueryResultSet resultSet,
  2. 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

  1. 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

  1. 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

  1. public static java.lang.String getLabel( java.lang.String propertyName,
  2. 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

  1. 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

  1. public java.util.Calendar getActivationTime( )
Returns the activationTime property.
Specified by:
See Also:

getAdminTaskID

  1. public TKIID getAdminTaskID()
Returns the adminTaskID property.
Specified by:
See Also:

getProcessAdminTaskID

  1. public TKIID getProcessAdminTaskID( )
Returns the processAdminTaskID property.
Specified by:
See Also:

getInvokedInstanceID

  1. public OID getInvokedInstanceID( )
Returns the invokedInstanceID property.
Specified by:
See Also:

getInvokedInstanceType

  1. public int getInvokedInstanceType( )
Returns the invokedInstanceType property.
Specified by:
See Also:

getActivityTemplateID

  1. public ATID getActivityTemplateID( )
Returns the activityTemplateID property.
Specified by:
See Also:

getApplicationName

  1. public java.lang.String getApplicationName( )
Returns the applicationName property.
Specified by:
See Also:

getAvailableActions

  1. public int[] getAvailableActions( )
Returns the availableActions property.
Specified by:
See Also:

getCompletionTime

  1. public java.util.Calendar getCompletionTime( )
Returns the completionTime property.
Specified by:
See Also:

getCustomProperty

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

getDescription

  1. public java.lang.String getDescription( )
Returns the description property.
Specified by:
See Also:

getDisplayName

  1. public java.lang.String getDisplayName( )
Returns the displayName property.
Specified by:
See Also:

getExecutionState

  1. 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:
See Also:

setExecutionState

  1. 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

  1. public java.util.Calendar getExpirationTime( )
Returns the expirationTime property.
Specified by:
See Also:

getFaultNames

  1. public java.util.List getFaultNames( )
Returns the faultNames property.
Specified by:
See Also:

getID

  1. public AIID getID()
Returns the ID property.
Specified by:
See Also:

getInputMessageTypeName

  1. public java.lang.String getInputMessageTypeName( )
Returns the inputMessageTypeName property.
Specified by:
See Also:

getInputMessageTypeTypeSystemName

  1. public java.lang.String getInputMessageTypeTypeSystemName( )
Deprecated.
Returns the inputMessageTypeTypeSystemName property.
Specified by:
See Also:

getKind

  1. public int getKind()
Returns the kind property.
Specified by:
See Also:

getLastModificationTime

  1. public java.util.Calendar getLastModificationTime( )
Returns the lastModificationTime property.
Specified by:
See Also:

getLastStateChangeTime

  1. public java.util.Calendar getLastStateChangeTime( )
Returns the lastStateChangeTime property.
Specified by:
See Also:

getName

  1. public java.lang.String getName( )
Returns the name property.
Specified by:
See Also:

getNamesOfCustomProperties

  1. public java.util.List getNamesOfCustomProperties( )
Returns the namesOfCustomProperties() property.
Specified by:
See Also:

getOutputMessageTypeName

  1. public java.lang.String getOutputMessageTypeName( )
Returns the outputMessageTypeName property.
Specified by:
See Also:

getOutputMessageTypeTypeSystemName

  1. public java.lang.String getOutputMessageTypeTypeSystemName( )
Deprecated.
Returns the outputMessageTypeTypeSystemName property.
Specified by:
See Also:

getOwner

  1. public java.lang.String getOwner( )
Returns the owner property.
Specified by:
See Also:

getProcessAdministrators

  1. public StaffResultSet getProcessAdministrators( )
  2. throws WorkItemManagerException
  3. InvalidLengthException
Returns the processAdministrators property.
Specified by:
Throws:
See Also:

getProcessInstanceID

  1. public PIID getProcessInstanceID( )
Returns the processInstanceID property.
Specified by:
See Also:

getProcessInstanceName

  1. public java.lang.String getProcessInstanceName( )
Returns the processInstanceName property.
Specified by:
See Also:

getProcessTemplateID

  1. public PTID getProcessTemplateID( )
Returns the processTemplateID property.
Specified by:
See Also:

getProcessTemplateName

  1. public java.lang.String getProcessTemplateName( )
Returns the processTemplateName property.
Specified by:
See Also:

getProcessTemplateDisplayName

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

getStartTime

  1. public java.util.Calendar getStartTime( )
Returns the startTime property.
Specified by:
See Also:

getTaskID

  1. public TKIID getTaskID()
Returns the taskID property.
Specified by:
See Also:

getScopeID

  1. public com.ibm.bpe.api.SIID getScopeID( )
Returns the scopeID property.
Specified by:
See Also:

getScopeTemplateID

  1. public com.ibm.bpe.api.STID getScopeTemplateID( )
Returns the scopeTemplateID property.
Specified by:
See Also:

getEventHandlerInstanceID

  1. public com.ibm.bpe.api.EHIID getEventHandlerInstanceID( )
Returns the eventHandlerInstanceID property.
Specified by:
See Also:

getEnclosingForEachID

  1. public com.ibm.bpe.api.FEIID getEnclosingForEachID( )
Returns the enclosingForEachID property.
Specified by:
See Also:

getUnhandledException

  1. public ProcessException getUnhandledException( )
Returns the unhandledException property.
Specified by:
See Also:

getStopReason

  1. public int getStopReason()
Returns the stopReason property.
Specified by:
See Also:

getSubState

  1. public int getSubState()
Returns the subState property.
Specified by:
See Also:

isBusinessRelevant

  1. public boolean isBusinessRelevant( )
Returns the businessRelevant property.
Specified by:
See Also:

getActivityClaimed

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

getInputMessageWrapper

  1. public MessageWrapper getInputMessageWrapper( )
  2. throws ClientException
Retrieves the input message.
Returns:
The wrapped message.
Throws:

getOutputMessageWrapper

  1. public MessageWrapper getOutputMessageWrapper( )
  2. throws ClientException
Retrieves the output message.
Returns:
The wrapped message.
Throws:

getFaultMessageWrapper

  1. public MessageWrapper getFaultMessageWrapper( )
  2. throws ClientException
Retrieves the fault message.
Returns:
The wrapped message.
Throws:

isSkipRequested

  1. public boolean isSkipRequested( )
Returns the skipRequested property.
Specified by:
See Also:

isContinueOnError

  1. public boolean isContinueOnError( )
Returns the continueOnError property.
Specified by:
See Also:

getPreviousExpirationTime

  1. 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:
See Also: