IBM WebSphere Application ServerTM
Release 8

com.ibm.bpe.clientmodel.bean
Class ProcessInstanceBean

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

public class ProcessInstanceBean
extends java.lang.Object
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
static java.lang.String AVAILABLEACTIONS_PROPERTY
          Use the property name to determine labels and converters for the applicationName property.
static java.lang.String COMPENSATIONSPHERENAME_PROPERTY
          Use the property name to determine labels and converters for the compensationSphereName property.
static java.lang.String COMPLETIONTIME_PROPERTY
          Use the property name to determine labels and converters for the completionTime 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, 2012.
static java.lang.String CREATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the creationTime property.
static java.lang.String CUSTOMPROPERTY_PROPERTY
          Use the property name to determine labels and converters for the customProperty property.
static java.lang.String CUSTOMTEXT1_PROPERTY
          Use the property name to determine labels and converters for the customText1 property.
static java.lang.String CUSTOMTEXT2_PROPERTY
          Use the property name to determine labels and converters for the customText2 property.
static java.lang.String CUSTOMTEXT3_PROPERTY
          Use the property name to determine labels and converters for the customText3 property.
static java.lang.String CUSTOMTEXT4_PROPERTY
          Use the property name to determine labels and converters for the customText4 property.
static java.lang.String CUSTOMTEXT5_PROPERTY
          Use the property name to determine labels and converters for the customText5 property.
static java.lang.String CUSTOMTEXT6_PROPERTY
          Use the property name to determine labels and converters for the customText6 property.
static java.lang.String CUSTOMTEXT7_PROPERTY
          Use the property name to determine labels and converters for the customText7 property.
static java.lang.String CUSTOMTEXT8_PROPERTY
          Use the property name to determine labels and converters for the customText8 property.
static java.lang.String DESCRIPTION_PROPERTY
          Use the property name to determine labels and converters for the description property.
static java.lang.String DISPLAYNAME_PROPERTY
          Use the property name to determine labels and converters for the displayName property.
static java.lang.String EXCEPTIONMESSAGE_PROPERTY
          Use the property name to determine labels and converters for theexceptionMessage property.
static java.lang.String EXECUTIONSTATE_PROPERTY
          Use the property name to determine labels and converters for the executionState property.
static java.lang.String FAULTNAME_PROPERTY
          Use the property name to determine labels and converters for the faultName property.
static java.lang.String ID_PROPERTY
          Use the property name to determine labels and converters for the ID property.
static java.lang.String INPUTMESSAGETPYENAME_PROPERTY
          Use the property name to determine labels and converters for the inputMessageTypeName property.
static java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
          Deprecated.  
static java.lang.String ISCOMPENSATIONDEFINED_PROPERTY
          Use the property name to determine labels and converters for the compensationDefined property.
static java.lang.String LASTMODIFICATIONTIME_PROPERTY
          Use the property name to determine labels and converters for the lastModificationTime property.
static java.lang.String LASTSTATECHANGETIME_PROPERTY
          Use the property name to determine labels and converters for the lastStateChange property.
static java.lang.String MIGRATED_PROPERTY
          Use the property name to determine labels and converters for the Migrated property.
static java.lang.String NAME_PROPERTY
          Use the property name to determine labels and converters for the name property.
static java.lang.String OUTPUTMESSAGETPYENAME_PROPERTY
          Use the property name to determine labels and converters for the outputMessageTypeName property.
static java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
          Deprecated.  
static java.lang.String PARENTACTIVITYINSTANCEID_PROPERTY
          Use the property name to determine labels and converters for the parentActivityInstanceID property.
static java.lang.String PARENTPROCESSINSTANCEID_PROPERTY
          Use the property name to determine labels and converters for the parentProcessInstanceID property.
static java.lang.String PARENTPROCESSINSTANCENAME_PROPERTY
          Use the property name to determine labels and converters for theparentProcessInstanceName property.
static java.lang.String PROCESSADMINISTRATORS_PROPERTY
          Use the property name to determine labels and converters for the processAdministrators property.
static java.lang.String PROCESSAPPACRONYM_PROPERTY
          Use the property name to determine labels and converters for the processAppAcronym property.
static java.lang.String PROCESSAPPNAME_PROPERTY
          Use the property name to determine labels and converters for the processAppName 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
          Use the property name to determine labels and converters for the processTemplateID property.
static java.lang.String PROCESSTEMPLATENAME_PROPERTY
          Use the property name to determine labels and converters for the processTemplateName property.
static java.lang.String RESUMPTIONTIME_PROPERTY
          Use the property name to determine labels and converters for the resumptionTime property.
static java.lang.String SNAPSHOTID_PROPERTY
          Use the property name to determine labels and converters for the snapshotID property.
static java.lang.String SNAPSHOTNAME_PROPERTY
          Use the property name to determine labels and converters for the snapshotName property.
static java.lang.String STARTER_PROPERTY
          Use the property name to determine labels and converters for the starter property.
static java.lang.String STARTTIME_PROPERTY
          Use the property name to determine labels and converters for the startTime property.
static java.lang.String TIP_PROPERTY
          Use the property name to determine labels and converters for the tip property.
static java.lang.String TOOLKITACRONYM_PROPERTY
          Use the property name to determine labels and converters for the toolkitAcronym property.
static java.lang.String TOOLKITNAME_PROPERTY
          Use the property name to determine labels and converters for the toolkitName property.
static java.lang.String TOOLKITSNAPSHOTID_PROPERTY
          Use the property name to determine labels and converters for the toolkitSnapshotID property.
static java.lang.String TOOLKITSNAPSHOTNAME_PROPERTY
          Use the property name to determine labels and converters for the toolkitSnapshotName property.
static java.lang.String TOPLEVELPROCESSINSTANCEID_PROPERTY
          Use the property name to determine labels and converters for the topLevelProcessInstanceID property.
static java.lang.String TOPLEVELPROCESSINSTANCENAME_PROPERTY
          Use the property name to determine labels and converters for the topLevelProcessInstanceName property.
static java.lang.String TOPLEVELTOOLKITACRONYM_PROPERTY
          Use the property name to determine labels and converters for the topLevelToolkitAcronym property.
static java.lang.String TOPLEVELTOOLKITNAME_PROPERTY
          Use the property name to determine labels and converters for the topLevelToolkitName property.
static java.lang.String TRACKNAME_PROPERTY
          Use the property name to determine labels and converters for the trackName property.
static java.lang.String UNHANDLEDEXCEPTION_PROPERTY
          Use the property name to determine labels and converters for theunhandledException property.
static 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
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
 TKIID getAdminTaskID()
          Returns the adminTaskID property.
 int[] getAvailableActions()
          Returns the availableActions property.
 java.lang.String getCompensationSphereName()
          Returns the compensationSphereName 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.util.Calendar getCreationTime()
          Returns the creationTime property.
 java.lang.String getCustomProperty(java.lang.String propertyName)
          Returns the customProperty property.
 java.lang.String getCustomText1()
          Returns the customText1 property.
 java.lang.String getCustomText2()
          Returns the customText2 property.
 java.lang.String getCustomText3()
          Returns the customText3 property.
 java.lang.String getCustomText4()
          Returns the customText4 property.
 java.lang.String getCustomText5()
          Returns the customText5 property.
 java.lang.String getCustomText6()
          Returns the customText6 property.
 java.lang.String getCustomText7()
          Returns the customText7 property.
 java.lang.String getCustomText8()
          Returns the customText8 property.
 java.lang.String getDescription()
          Returns the description property.
 java.lang.String getDisplayName()
          Returns the displayName property.
 int getExecutionState()
          Returns the executionState property.
 MessageWrapper getFaultMessageWrapper()
          Retrieves the fault message.
 java.lang.String getFaultName()
          Returns the faultName property.
 PIID getID()
          Returns the ID property.
 java.lang.String getInputMessageTypeName()
          Returns the inputMessageTypeName property.
 java.lang.String getInputMessageTypeTypeSystemName()
          Deprecated.  
 MessageWrapper getInputMessageWrapper()
          Retrieves the input message.
static java.lang.String getLabel(java.lang.String propertyName)
          Returns the resource bundle key for a property
static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
          Returns the label for a property from the resource bundle.
 java.util.Calendar getLastModificationTime()
          Returns the 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.
 AIID getParentActivityInstanceID()
          Returns the parentActivityInstanceID property.
 PIID getParentProcessInstanceID()
          Returns the parentProcessInstanceID property.
 java.lang.String getParentProcessInstanceName()
          Returns the parentProcessInstanceName property.
 StaffResultSet getProcessAdministrators()
          Returns the processAdministrators property.
 java.lang.String getProcessAppAcronym()
          Returns the processAppAcronym property.
 java.lang.String getProcessAppName()
          Returns the processAppName property.
 java.lang.String getProcessTemplateDisplayName()
          Returns the processTemplateDisplayName property.
 PTID getProcessTemplateID()
          Returns the processTemplateID property.
 java.lang.String getProcessTemplateName()
          Returns the processTemplateName property.
 java.util.Calendar getResumptionTime()
          Returns the resumptionTime property.
 java.lang.String getSnapshotID()
          Returns the snapshotID property.
 java.lang.String getSnapshotName()
          Returns the snapshotName property.
 java.lang.String getStarter()
          Returns the starter property.
 java.util.Calendar getStartTime()
          Returns the startTime property.
 java.lang.String getToolkitAcronym()
          Returns the toolkitAcronym property.
 java.lang.String getToolkitName()
          Returns the toolkitName property.
 java.lang.String getToolkitSnapshotID()
          Returns the toolkitSnapshotID property.
 java.lang.String getToolkitSnapshotName()
          Returns the toolkitSnapshotName property.
 PIID getTopLevelProcessInstanceID()
          Returns the topLevelProcessInstanceID property.
 java.lang.String getTopLevelProcessInstanceName()
          Returns the topLevelProcessInstanceName property.
 java.lang.String getTopLevelToolkitAcronym()
          Returns the topLevelToolkitAcronym property.
 java.lang.String getTopLevelToolkitName()
          Returns the topLevelToolkitName property.
 java.lang.String getTrackName()
          Returns the trackName property.
 ProcessException getUnhandledException()
          Retrieves the unhandled exception.
 java.util.Calendar getValidFromTime()
          Returns the validFromTime property.
 boolean isBusinessRelevant()
          Returns the businessRelevant property.
 boolean isCompensationDefined()
          Returns the compensationDefined property.
 boolean isContinueOnError()
          Returns the continueOnError property.
 boolean isMigrated()
          States whether the process instance has been migrated.
 boolean isTip()
          Returns the isTip property.
static boolean isValid(java.lang.String propertyName)
          Checks whether the property is valid.
 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

COPYRIGHT

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

See Also:
Constant Field Values

AVAILABLEACTIONS_PROPERTY

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

See Also:
Constant Field Values

COMPENSATIONSPHERENAME_PROPERTY

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

See Also:
Constant Field Values

COMPLETIONTIME_PROPERTY

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

RESUMPTIONTIME_PROPERTY

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

See Also:
Constant Field Values

CREATIONTIME_PROPERTY

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

See Also:
Constant Field Values

CUSTOMPROPERTY_PROPERTY

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

See Also:
Constant Field Values

DESCRIPTION_PROPERTY

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

See Also:
Constant Field Values

EXECUTIONSTATE_PROPERTY

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

See Also:
Constant Field Values

FAULTNAME_PROPERTY

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

See Also:
Constant Field Values

ID_PROPERTY

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

See Also:
Constant Field Values

ISCOMPENSATIONDEFINED_PROPERTY

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

See Also:
Constant Field Values

INPUTMESSAGETPYENAME_PROPERTY

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

See Also:
Constant Field Values

INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

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

See Also:
Constant Field Values

LASTMODIFICATIONTIME_PROPERTY

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

See Also:
Constant Field Values

LASTSTATECHANGETIME_PROPERTY

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

See Also:
Constant Field Values

MIGRATED_PROPERTY

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

See Also:
Constant Field Values

NAME_PROPERTY

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

See Also:
Constant Field Values

OUTPUTMESSAGETPYENAME_PROPERTY

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

See Also:
Constant Field Values

OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY

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

See Also:
Constant Field Values

PROCESSADMINISTRATORS_PROPERTY

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:
Constant Field Values

PROCESSTEMPLATEID_PROPERTY

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

See Also:
Constant Field Values

PROCESSTEMPLATENAME_PROPERTY

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

STARTER_PROPERTY

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

See Also:
Constant Field Values

STARTTIME_PROPERTY

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

See Also:
Constant Field Values

TOPLEVELPROCESSINSTANCEID_PROPERTY

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

See Also:
Constant Field Values

TOPLEVELPROCESSINSTANCENAME_PROPERTY

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

See Also:
Constant Field Values

PARENTPROCESSINSTANCEID_PROPERTY

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

See Also:
Constant Field Values

PARENTACTIVITYINSTANCEID_PROPERTY

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

See Also:
Constant Field Values

PARENTPROCESSINSTANCENAME_PROPERTY

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

See Also:
Constant Field Values

UNHANDLEDEXCEPTION_PROPERTY

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

See Also:
Constant Field Values

EXCEPTIONMESSAGE_PROPERTY

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

See Also:
Constant Field Values

VALIDFROMTIME_PROPERTY

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

See Also:
Constant Field Values

SNAPSHOTID_PROPERTY

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

See Also:
Constant Field Values

SNAPSHOTNAME_PROPERTY

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

See Also:
Constant Field Values

TRACKNAME_PROPERTY

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

See Also:
Constant Field Values

PROCESSAPPNAME_PROPERTY

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

See Also:
Constant Field Values

PROCESSAPPACRONYM_PROPERTY

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

See Also:
Constant Field Values

TOOLKITSNAPSHOTID_PROPERTY

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

See Also:
Constant Field Values

TOOLKITSNAPSHOTNAME_PROPERTY

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

See Also:
Constant Field Values

TOOLKITNAME_PROPERTY

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

See Also:
Constant Field Values

TOOLKITACRONYM_PROPERTY

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

See Also:
Constant Field Values

TOPLEVELTOOLKITNAME_PROPERTY

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

See Also:
Constant Field Values

TOPLEVELTOOLKITACRONYM_PROPERTY

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

See Also:
Constant Field Values

TIP_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT1_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT2_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT3_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT4_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT5_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT6_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT7_PROPERTY

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

See Also:
Constant Field Values

CUSTOMTEXT8_PROPERTY

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

See Also:
Constant Field Values
Constructor Detail

ProcessInstanceBean

public ProcessInstanceBean(ProcessInstanceData processInstance,
                           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

public ProcessInstanceBean(QueryResultSet resultSet,
                           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

public ProcessInstanceBean(QueryResultSet resultSet,
                           java.lang.String processDataViewName,
                           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

public ProcessInstanceBean(PIID id,
                           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

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

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

public TKIID getAdminTaskID()
Returns the adminTaskID property.

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

getAvailableActions

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

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

getCompensationSphereName

public java.lang.String getCompensationSphereName()
Returns the compensationSphereName property.

Specified by:
getCompensationSphereName in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCompensationSphereName()

getCompletionTime

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

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

getResumptionTime

public java.util.Calendar getResumptionTime()
Returns the resumptionTime property.

Specified by:
getResumptionTime in interface ProcessInstanceData
See Also:
ProcessInstanceData.getResumptionTime()

getCreationTime

public java.util.Calendar getCreationTime()
Returns the creationTime property.

Specified by:
getCreationTime in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCreationTime()

getCustomProperty

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

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

getDescription

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

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

getDisplayName

public java.lang.String getDisplayName()
Returns the displayName property. Returns the name property when a display name is not assigned.

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

getExecutionState

public int getExecutionState()
Returns the executionState property.

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

getFaultName

public java.lang.String getFaultName()
Returns the faultName property.

Specified by:
getFaultName in interface ProcessInstanceData
See Also:
ProcessInstanceData.getFaultName()

getID

public PIID getID()
Returns the ID property.

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

getInputMessageTypeName

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

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

getInputMessageTypeTypeSystemName

public java.lang.String getInputMessageTypeTypeSystemName()
Deprecated. 

Returns the inputMessageTypeTypeSystemName property.

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

getLastModificationTime

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

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

getLastStateChangeTime

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

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

getName

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

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

getNamesOfCustomProperties

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

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

getOutputMessageTypeName

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

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

getOutputMessageTypeTypeSystemName

public java.lang.String getOutputMessageTypeTypeSystemName()
Deprecated. 

Returns the outputMessageTypeTypeSystemName property.

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

getProcessAdministrators

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

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

getProcessTemplateID

public PTID getProcessTemplateID()
Returns the processTemplateID property.

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

getProcessTemplateName

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

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

getProcessTemplateDisplayName

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


getStarter

public java.lang.String getStarter()
Returns the starter property.

Specified by:
getStarter in interface ProcessInstanceData
See Also:
ProcessInstanceData.getStarter()

getStartTime

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

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

getTopLevelProcessInstanceID

public PIID getTopLevelProcessInstanceID()
Returns the topLevelProcessInstanceID property.

Specified by:
getTopLevelProcessInstanceID in interface ProcessInstanceData
See Also:
ProcessInstanceData.getTopLevelProcessInstanceID()

getTopLevelProcessInstanceName

public java.lang.String getTopLevelProcessInstanceName()
Returns the topLevelProcessInstanceName property.

Specified by:
getTopLevelProcessInstanceName in interface ProcessInstanceData
See Also:
ProcessInstanceData.getTopLevelProcessInstanceName()

getParentProcessInstanceName

public java.lang.String getParentProcessInstanceName()
Returns the parentProcessInstanceName property.

Specified by:
getParentProcessInstanceName in interface ProcessInstanceData
See Also:
ProcessInstanceData.getParentProcessInstanceName()

getParentProcessInstanceID

public PIID getParentProcessInstanceID()
Returns the parentProcessInstanceID property.

Specified by:
getParentProcessInstanceID in interface ProcessInstanceData
See Also:
ProcessInstanceData.getParentProcessInstanceID()

getParentActivityInstanceID

public AIID getParentActivityInstanceID()
Returns the parentActivityInstanceID property.

Specified by:
getParentActivityInstanceID in interface ProcessInstanceData
See Also:
ProcessInstanceData.getParentActivityInstanceID()

getValidFromTime

public java.util.Calendar getValidFromTime()
Returns the validFromTime property.

Specified by:
getValidFromTime in interface ProcessInstanceData
See Also:
ProcessInstanceData.getValidFromTime()

getSnapshotID

public java.lang.String getSnapshotID()
Returns the snapshotID property.

See Also:
ProcessTemplateData.getSnapshotID()

getSnapshotName

public java.lang.String getSnapshotName()
Returns the snapshotName property.

See Also:
ProcessTemplateData.getSnapshotName()

getTrackName

public java.lang.String getTrackName()
Returns the trackName property.

See Also:
ProcessTemplateData.getTrackName()

getProcessAppName

public java.lang.String getProcessAppName()
Returns the processAppName property.

See Also:
ProcessTemplateData.getProcessAppName()

getProcessAppAcronym

public java.lang.String getProcessAppAcronym()
Returns the processAppAcronym property.

See Also:
ProcessTemplateData.getProcessAppAcronym()

getToolkitSnapshotID

public java.lang.String getToolkitSnapshotID()
Returns the toolkitSnapshotID property.

See Also:
ProcessTemplateData.getToolkitSnapshotID()

getToolkitSnapshotName

public java.lang.String getToolkitSnapshotName()
Returns the toolkitSnapshotName property.

See Also:
ProcessTemplateData.getToolkitSnapshotName()

getToolkitName

public java.lang.String getToolkitName()
Returns the toolkitName property.

See Also:
ProcessTemplateData.getToolkitName()

getToolkitAcronym

public java.lang.String getToolkitAcronym()
Returns the toolkitAcronym property.

See Also:
ProcessTemplateData.getToolkitAcronym()

getTopLevelToolkitName

public java.lang.String getTopLevelToolkitName()
Returns the topLevelToolkitName property.

See Also:
ProcessTemplateData.getTopLevelToolkitName()

getTopLevelToolkitAcronym

public java.lang.String getTopLevelToolkitAcronym()
Returns the topLevelToolkitAcronym property.

See Also:
ProcessTemplateData.getTopLevelToolkitAcronym()

isTip

public boolean isTip()
Returns the isTip property.

See Also:
ProcessTemplateData.isTip()

isBusinessRelevant

public boolean isBusinessRelevant()
Returns the businessRelevant property.

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

isCompensationDefined

public boolean isCompensationDefined()
Returns the compensationDefined property.

Specified by:
isCompensationDefined in interface ProcessInstanceData
See Also:
ProcessInstanceData.isCompensationDefined()

setExecutionState

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

public MessageWrapper getInputMessageWrapper()
                                      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:
ClientException

getOutputMessageWrapper

public MessageWrapper getOutputMessageWrapper()
                                       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:
ClientException

getFaultMessageWrapper

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

Returns:
The wrapped message.
Throws:
ClientException

getUnhandledException

public ProcessException getUnhandledException()
Retrieves the unhandled exception.

Specified by:
getUnhandledException in interface ProcessInstanceData
Returns:
The process instance's unhandled exception.

isContinueOnError

public boolean isContinueOnError()
Returns the continueOnError property.

Specified by:
isContinueOnError in interface ProcessInstanceData
See Also:
ProcessTemplateData.isContinueOnError()

isMigrated

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:
isMigrated in interface ProcessInstanceData

getCustomText1

public java.lang.String getCustomText1()
Returns the customText1 property.

Specified by:
getCustomText1 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText1()

getCustomText2

public java.lang.String getCustomText2()
Returns the customText2 property.

Specified by:
getCustomText2 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText2()

getCustomText3

public java.lang.String getCustomText3()
Returns the customText3 property.

Specified by:
getCustomText3 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText3()

getCustomText4

public java.lang.String getCustomText4()
Returns the customText4 property.

Specified by:
getCustomText4 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText4()

getCustomText5

public java.lang.String getCustomText5()
Returns the customText5 property.

Specified by:
getCustomText5 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText5()

getCustomText6

public java.lang.String getCustomText6()
Returns the customText6 property.

Specified by:
getCustomText6 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText6()

getCustomText7

public java.lang.String getCustomText7()
Returns the customText7 property.

Specified by:
getCustomText7 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText7()

getCustomText8

public java.lang.String getCustomText8()
Returns the customText8 property.

Specified by:
getCustomText8 in interface ProcessInstanceData
See Also:
ProcessInstanceData.getCustomText8()

IBM WebSphere Application ServerTM
Release 8