com.ibm.bpe.clientmodel.bean

Class ProcessInstanceBean

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

  1. public class ProcessInstanceBean
  2. extends java.lang.Object
  3. implements ProcessInstanceData

Accesses the properties of the original ProcessInstanceData object and adds metadata for national language support and converters.

A ProcessInstanceBean object can be instantiated from either a QueryResultSet object or a ProcessInstanceData 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 the property is not found in the query result set, the property remains empty. Accessing an empty property requires the bean to 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. The return value might be null, as converters are optional.

See Also:
ProcessInstanceData, QueryResultSet, Serialized Form

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
AVAILABLEACTIONS_PROPERTY
Use the property name to determine labels and converters for the applicationName property.
  1. static
  2. java.lang.String
COMPENSATIONSPHERENAME_PROPERTY
Use the property name to determine labels and converters for the compensationSphereName property.
  1. static
  2. java.lang.String
COMPLETIONTIME_PROPERTY
Use the property name to determine labels and converters for the completionTime 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, 2012.
  1. static
  2. java.lang.String
CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the creationTime property.
  1. static
  2. java.lang.String
CUSTOMPROPERTY_PROPERTY
Use the property name to determine labels and converters for the customProperty property.
  1. static
  2. java.lang.String
CUSTOMTEXT1_PROPERTY
Use the property name to determine labels and converters for the customText1 property.
  1. static
  2. java.lang.String
CUSTOMTEXT2_PROPERTY
Use the property name to determine labels and converters for the customText2 property.
  1. static
  2. java.lang.String
CUSTOMTEXT3_PROPERTY
Use the property name to determine labels and converters for the customText3 property.
  1. static
  2. java.lang.String
CUSTOMTEXT4_PROPERTY
Use the property name to determine labels and converters for the customText4 property.
  1. static
  2. java.lang.String
CUSTOMTEXT5_PROPERTY
Use the property name to determine labels and converters for the customText5 property.
  1. static
  2. java.lang.String
CUSTOMTEXT6_PROPERTY
Use the property name to determine labels and converters for the customText6 property.
  1. static
  2. java.lang.String
CUSTOMTEXT7_PROPERTY
Use the property name to determine labels and converters for the customText7 property.
  1. static
  2. java.lang.String
CUSTOMTEXT8_PROPERTY
Use the property name to determine labels and converters for the customText8 property.
  1. static
  2. java.lang.String
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the description property.
  1. static
  2. java.lang.String
DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the displayName property.
  1. static
  2. java.lang.String
EXCEPTIONMESSAGE_PROPERTY
Use the property name to determine labels and converters for theexceptionMessage property.
  1. static
  2. java.lang.String
EXECUTIONSTATE_PROPERTY
Use the property name to determine labels and converters for the executionState property.
  1. static
  2. java.lang.String
FAULTNAME_PROPERTY
Use the property name to determine labels and converters for the faultName property.
  1. static
  2. java.lang.String
ID_PROPERTY
Use the property name to determine labels and converters for the ID property.
  1. static
  2. java.lang.String
INPUTMESSAGETPYENAME_PROPERTY
Use the property name to determine labels and converters for the inputMessageTypeName property.
  1. static
  2. java.lang.String
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
  1. static
  2. java.lang.String
ISCOMPENSATIONDEFINED_PROPERTY
Use the property name to determine labels and converters for the compensationDefined property.
  1. static
  2. java.lang.String
LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the lastModificationTime property.
  1. static
  2. java.lang.String
LASTSTATECHANGETIME_PROPERTY
Use the property name to determine labels and converters for the lastStateChange property.
  1. static
  2. java.lang.String
MIGRATED_PROPERTY
Use the property name to determine labels and converters for the Migrated property.
  1. static
  2. java.lang.String
NAME_PROPERTY
Use the property name to determine labels and converters for the name property.
  1. static
  2. java.lang.String
OUTPUTMESSAGETPYENAME_PROPERTY
Use the property name to determine labels and converters for the outputMessageTypeName property.
  1. static
  2. java.lang.String
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
  1. static
  2. java.lang.String
PARENTACTIVITYINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the parentActivityInstanceID property.
  1. static
  2. java.lang.String
PARENTPROCESSINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the parentProcessInstanceID property.
  1. static
  2. java.lang.String
PARENTPROCESSINSTANCENAME_PROPERTY
Use the property name to determine labels and converters for theparentProcessInstanceName property.
  1. static
  2. java.lang.String
PROCESSADMINISTRATORS_PROPERTY
Use the property name to determine labels and converters for the processAdministrators property.
  1. static
  2. java.lang.String
PROCESSAPPACRONYM_PROPERTY
Use the property name to determine labels and converters for the processAppAcronym property.
  1. static
  2. java.lang.String
PROCESSAPPNAME_PROPERTY
Use the property name to determine labels and converters for the processAppName 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
Use the property name to determine labels and converters for the processTemplateID property.
  1. static
  2. java.lang.String
PROCESSTEMPLATENAME_PROPERTY
Use the property name to determine labels and converters for the processTemplateName property.
  1. static
  2. java.lang.String
RESUMPTIONTIME_PROPERTY
Use the property name to determine labels and converters for the resumptionTime property.
  1. static
  2. java.lang.String
SNAPSHOTID_PROPERTY
Use the property name to determine labels and converters for the snapshotID property.
  1. static
  2. java.lang.String
SNAPSHOTNAME_PROPERTY
Use the property name to determine labels and converters for the snapshotName property.
  1. static
  2. java.lang.String
STARTER_PROPERTY
Use the property name to determine labels and converters for the starter property.
  1. static
  2. java.lang.String
STARTTIME_PROPERTY
Use the property name to determine labels and converters for the startTime property.
  1. static
  2. java.lang.String
TIP_PROPERTY
Use the property name to determine labels and converters for the tip property.
  1. static
  2. java.lang.String
TOOLKITACRONYM_PROPERTY
Use the property name to determine labels and converters for the toolkitAcronym property.
  1. static
  2. java.lang.String
TOOLKITNAME_PROPERTY
Use the property name to determine labels and converters for the toolkitName property.
  1. static
  2. java.lang.String
TOOLKITSNAPSHOTID_PROPERTY
Use the property name to determine labels and converters for the toolkitSnapshotID property.
  1. static
  2. java.lang.String
TOOLKITSNAPSHOTNAME_PROPERTY
Use the property name to determine labels and converters for the toolkitSnapshotName property.
  1. static
  2. java.lang.String
TOPLEVELPROCESSINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the topLevelProcessInstanceID property.
  1. static
  2. java.lang.String
TOPLEVELPROCESSINSTANCENAME_PROPERTY
Use the property name to determine labels and converters for the topLevelProcessInstanceName property.
  1. static
  2. java.lang.String
TOPLEVELTOOLKITACRONYM_PROPERTY
Use the property name to determine labels and converters for the topLevelToolkitAcronym property.
  1. static
  2. java.lang.String
TOPLEVELTOOLKITNAME_PROPERTY
Use the property name to determine labels and converters for the topLevelToolkitName property.
  1. static
  2. java.lang.String
TRACKNAME_PROPERTY
Use the property name to determine labels and converters for the trackName property.
  1. static
  2. java.lang.String
UNHANDLEDEXCEPTION_PROPERTY
Use the property name to determine labels and converters for theunhandledException property.
  1. static
  2. java.lang.String
VALIDFROMTIME_PROPERTY
Use the property name to determine labels and converters for thevalidFromTime property
Fields inherited from interface com.ibm.bpe.api.ProcessInstanceData
STATE_COMPENSATED, STATE_COMPENSATING, STATE_COMPENSATION_FAILED, STATE_DELETED, STATE_FAILED, STATE_FAILING, STATE_FINISHED, STATE_INDOUBT, STATE_READY, STATE_RUNNING, STATE_SUSPENDED, STATE_TERMINATED, STATE_TERMINATING

Constructor Summary

Constructor and Description
ProcessInstanceBean(PIID id,BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a process instance id
ProcessInstanceBean(ProcessInstanceData processInstance,BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from an original ProcessInstanceData object.
ProcessInstanceBean(QueryResultSet resultSet,BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a QueryResultSet.
ProcessInstanceBean(QueryResultSet resultSet,java.lang.String processDataViewName,BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a QueryResultSet.

Method Summary

Modifier and Type Method and Description
  1. TKIID
getAdminTaskID()
Returns the adminTaskID property.
  1. int[]
getAvailableActions()
Returns the availableActions property.
  1. java.lang.String
getCompensationSphereName()
Returns the compensationSphereName 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.util.Calendar
getCreationTime()
Returns the creationTime property.
  1. java.lang.String
getCustomProperty(java.lang.String propertyName)
Returns the customProperty property.
  1. java.lang.String
getCustomText1()
Returns the customText1 property.
  1. java.lang.String
getCustomText2()
Returns the customText2 property.
  1. java.lang.String
getCustomText3()
Returns the customText3 property.
  1. java.lang.String
getCustomText4()
Returns the customText4 property.
  1. java.lang.String
getCustomText5()
Returns the customText5 property.
  1. java.lang.String
getCustomText6()
Returns the customText6 property.
  1. java.lang.String
getCustomText7()
Returns the customText7 property.
  1. java.lang.String
getCustomText8()
Returns the customText8 property.
  1. java.lang.String
getDescription()
Returns the description property.
  1. java.lang.String
getDisplayName()
Returns the displayName property.
  1. int
getExecutionState()
Returns the executionState property.
  1. MessageWrapper
getFaultMessageWrapper()
Retrieves the fault message.
  1. java.lang.String
getFaultName()
Returns the faultName property.
  1. PIID
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. 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 for 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. AIID
getParentActivityInstanceID()
Returns the parentActivityInstanceID property.
  1. PIID
getParentProcessInstanceID()
Returns the parentProcessInstanceID property.
  1. java.lang.String
getParentProcessInstanceName()
Returns the parentProcessInstanceName property.
  1. StaffResultSet
getProcessAdministrators()
Returns the processAdministrators property.
  1. java.lang.String
getProcessAppAcronym()
Returns the processAppAcronym property.
  1. java.lang.String
getProcessAppName()
Returns the processAppName 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. java.util.Calendar
getResumptionTime()
Returns the resumptionTime property.
  1. java.lang.String
getSnapshotID()
Returns the snapshotID property.
  1. java.lang.String
getSnapshotName()
Returns the snapshotName property.
  1. java.lang.String
getStarter()
Returns the starter property.
  1. java.util.Calendar
getStartTime()
Returns the startTime property.
  1. java.lang.String
getToolkitAcronym()
Returns the toolkitAcronym property.
  1. java.lang.String
getToolkitName()
Returns the toolkitName property.
  1. java.lang.String
getToolkitSnapshotID()
Returns the toolkitSnapshotID property.
  1. java.lang.String
getToolkitSnapshotName()
Returns the toolkitSnapshotName property.
  1. PIID
getTopLevelProcessInstanceID()
Returns the topLevelProcessInstanceID property.
  1. java.lang.String
getTopLevelProcessInstanceName()
Returns the topLevelProcessInstanceName property.
  1. java.lang.String
getTopLevelToolkitAcronym()
Returns the topLevelToolkitAcronym property.
  1. java.lang.String
getTopLevelToolkitName()
Returns the topLevelToolkitName property.
  1. java.lang.String
getTrackName()
Returns the trackName property.
  1. ProcessException
getUnhandledException()
Retrieves the unhandled exception.
  1. java.util.Calendar
getValidFromTime()
Returns the validFromTime property.
  1. boolean
isBusinessRelevant()
Returns the businessRelevant property.
  1. boolean
isCompensationDefined()
Returns the compensationDefined property.
  1. boolean
isContinueOnError()
Returns the continueOnError property.
  1. boolean
isMigrated()
  1. boolean
isTip()
Returns the isTip property.
  1. static
  2. boolean
isValid(java.lang.String propertyName)
Checks whether the property is valid.
  1. void
setExecutionState(int state)
Changes the executionState property of the process instance.
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, 2012.
See Also:

AVAILABLEACTIONS_PROPERTY

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

COMPENSATIONSPHERENAME_PROPERTY

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

COMPLETIONTIME_PROPERTY

  1. public static final java.lang.String COMPLETIONTIME_PROPERTY
Use the property name to determine labels and converters for the completionTime 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:

RESUMPTIONTIME_PROPERTY

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

CREATIONTIME_PROPERTY

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

CUSTOMPROPERTY_PROPERTY

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

DESCRIPTION_PROPERTY

  1. public static final java.lang.String DESCRIPTION_PROPERTY
Use 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
Use the property name to determine labels and converters for the displayName property.
See Also:

EXECUTIONSTATE_PROPERTY

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

FAULTNAME_PROPERTY

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

ID_PROPERTY

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

ISCOMPENSATIONDEFINED_PROPERTY

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

INPUTMESSAGETPYENAME_PROPERTY

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

INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

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

LASTMODIFICATIONTIME_PROPERTY

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

LASTSTATECHANGETIME_PROPERTY

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

MIGRATED_PROPERTY

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

NAME_PROPERTY

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

OUTPUTMESSAGETPYENAME_PROPERTY

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

OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

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

PROCESSADMINISTRATORS_PROPERTY

  1. public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
Use the property name to determine labels and converters for the processAdministrators property. admard: since 7.0.0.2 no longer deprecated
See Also:

PROCESSTEMPLATEID_PROPERTY

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

PROCESSTEMPLATENAME_PROPERTY

  1. public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
Use the property name to determine labels and converters for the processTemplateName 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:

STARTER_PROPERTY

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

STARTTIME_PROPERTY

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

TOPLEVELPROCESSINSTANCEID_PROPERTY

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

TOPLEVELPROCESSINSTANCENAME_PROPERTY

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

PARENTPROCESSINSTANCEID_PROPERTY

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

PARENTACTIVITYINSTANCEID_PROPERTY

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

PARENTPROCESSINSTANCENAME_PROPERTY

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

UNHANDLEDEXCEPTION_PROPERTY

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

EXCEPTIONMESSAGE_PROPERTY

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

VALIDFROMTIME_PROPERTY

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

SNAPSHOTID_PROPERTY

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

SNAPSHOTNAME_PROPERTY

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

TRACKNAME_PROPERTY

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

PROCESSAPPNAME_PROPERTY

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

PROCESSAPPACRONYM_PROPERTY

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

TOOLKITSNAPSHOTID_PROPERTY

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

TOOLKITSNAPSHOTNAME_PROPERTY

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

TOOLKITNAME_PROPERTY

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

TOOLKITACRONYM_PROPERTY

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

TOPLEVELTOOLKITNAME_PROPERTY

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

TOPLEVELTOOLKITACRONYM_PROPERTY

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

TIP_PROPERTY

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

CUSTOMTEXT1_PROPERTY

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

CUSTOMTEXT2_PROPERTY

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

CUSTOMTEXT3_PROPERTY

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

CUSTOMTEXT4_PROPERTY

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

CUSTOMTEXT5_PROPERTY

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

CUSTOMTEXT6_PROPERTY

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

CUSTOMTEXT7_PROPERTY

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

CUSTOMTEXT8_PROPERTY

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

Constructor Detail

ProcessInstanceBean

  1. public ProcessInstanceBean(ProcessInstanceData processInstance,
  2. BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from an original ProcessInstanceData object.
Parameters:
processInstance - The original data object.
bfmConnection - The connection to the BusinessFlowManagerService API.

ProcessInstanceBean

  1. public ProcessInstanceBean(QueryResultSet resultSet,
  2. BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a QueryResultSet.
Parameters:
resultSet - The result object of a query.
bfmConnection - The connection to the BusinessFlowManagerService API.

ProcessInstanceBean

  1. public ProcessInstanceBean(QueryResultSet resultSet,
  2. java.lang.String processDataViewName,
  3. BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a QueryResultSet.
Parameters:
resultSet - The result object of a query.
processDataViewName - Name of the view from where to retrieve process instance attributes
bfmConnection - The connection to the BusinessFlowManagerService API.

ProcessInstanceBean

  1. public ProcessInstanceBean(PIID id,
  2. BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a process instance id
Parameters:
id - The process instance id.
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 for 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 whether the property is valid.
Parameters:
propertyName - The name of the property to be checked.
Returns:
True if propertyName is a known property for an object of this class.

getAdminTaskID

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

getAvailableActions

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

getCompensationSphereName

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

getCompletionTime

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

getResumptionTime

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

getCreationTime

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

getCustomProperty

  1. public java.lang.String getCustomProperty( java.lang.String propertyName)
Returns the customProperty property.
Specified by:
Parameters:
propertyName - 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. Returns the name property when a display name is not assigned.
Specified by:
See Also:

getExecutionState

  1. public int getExecutionState()
Returns the executionState property.
Specified by:
See Also:

getFaultName

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

getID

  1. public PIID getID()
Returns the ID property.
Specified by:
getID in interface ProcessInstanceData
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:

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:

getProcessAdministrators

  1. public StaffResultSet getProcessAdministrators( )
  2. throws WorkItemManagerException
  3. InvalidLengthException
Returns the processAdministrators property.
Specified by:
Throws:
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.

getStarter

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

getStartTime

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

getTopLevelProcessInstanceID

  1. public PIID getTopLevelProcessInstanceID( )
Returns the topLevelProcessInstanceID property.
Specified by:
See Also:

getTopLevelProcessInstanceName

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

getParentProcessInstanceName

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

getParentProcessInstanceID

  1. public PIID getParentProcessInstanceID( )
Returns the parentProcessInstanceID property.
Specified by:
See Also:

getParentActivityInstanceID

  1. public AIID getParentActivityInstanceID( )
Returns the parentActivityInstanceID property.
Specified by:
See Also:

getValidFromTime

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

getSnapshotID

  1. public java.lang.String getSnapshotID( )
Returns the snapshotID property.
See Also:

getSnapshotName

  1. public java.lang.String getSnapshotName( )
Returns the snapshotName property.
See Also:

getTrackName

  1. public java.lang.String getTrackName( )
Returns the trackName property.
See Also:

getProcessAppName

  1. public java.lang.String getProcessAppName( )
Returns the processAppName property.
See Also:

getProcessAppAcronym

  1. public java.lang.String getProcessAppAcronym( )
Returns the processAppAcronym property.
See Also:

getToolkitSnapshotID

  1. public java.lang.String getToolkitSnapshotID( )
Returns the toolkitSnapshotID property.
See Also:

getToolkitSnapshotName

  1. public java.lang.String getToolkitSnapshotName( )
Returns the toolkitSnapshotName property.
See Also:

getToolkitName

  1. public java.lang.String getToolkitName( )
Returns the toolkitName property.
See Also:

getToolkitAcronym

  1. public java.lang.String getToolkitAcronym( )
Returns the toolkitAcronym property.
See Also:

getTopLevelToolkitName

  1. public java.lang.String getTopLevelToolkitName( )
Returns the topLevelToolkitName property.
See Also:

getTopLevelToolkitAcronym

  1. public java.lang.String getTopLevelToolkitAcronym( )
Returns the topLevelToolkitAcronym property.
See Also:

isTip

  1. public boolean isTip()
Returns the isTip property.
See Also:

isBusinessRelevant

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

isCompensationDefined

  1. public boolean isCompensationDefined( )
Returns the compensationDefined property.
Specified by:
See Also:

setExecutionState

  1. public void setExecutionState(int state)
Changes the executionState property of the process instance. This may become necessary, for example, if a process instance is terminated, suspended or restarted through the BPC Explorer.
Be aware that the ProcessInstanceBean and ProcessInstanceDataserver objects may be different and the object should therefore be refreshed if necessary.
Parameters:
state - The new state of the process instance.

getInputMessageWrapper

  1. public MessageWrapper getInputMessageWrapper( )
  2. throws ClientException
Retrieves the input message. If Web client settings are available, the context root and the URL are retrieved.
Returns:
The wrapped message and Web client settings.
Throws:

getOutputMessageWrapper

  1. public MessageWrapper getOutputMessageWrapper( )
  2. throws ClientException
Retrieves the output message. If Web client settings are available, the context root and the URL are retrieved.
Returns:
The wrapped message and Web client settings.
Throws:

getFaultMessageWrapper

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

getUnhandledException

  1. public ProcessException getUnhandledException( )
Retrieves the unhandled exception.
Specified by:
Returns:
The process instance's unhandled exception.

isContinueOnError

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

isMigrated

  1. public boolean isMigrated()
Description copied from interface: ProcessInstanceData
States whether the process instance has been migrated. True states that the process instance has been migrated. False states that the process instance has not been migrated.
Specified by:

getCustomText1

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

getCustomText2

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

getCustomText3

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

getCustomText4

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

getCustomText5

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

getCustomText6

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

getCustomText7

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

getCustomText8

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