com.ibm.bpe.clientmodel.bean
Class ProcessInstanceBean
- java.lang.Object
com.ibm.bpe.clientmodel.bean.ProcessInstanceBean
- 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:
ID
completionTime
creationTime
description
name
parentProcessInstanceName
startTime
starter
executionState
processTemplateName
processTemplateDisplayName
topLevelProcessInstanceName
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.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
AVAILABLEACTIONS_PROPERTY
Use the property name to determine labels and converters for the
applicationName property.
|
|
COMPENSATIONSPHERENAME_PROPERTY
Use the property name to determine labels and converters for the
compensationSphereName property.
|
|
COMPLETIONTIME_PROPERTY
Use the property name to determine labels and converters for the
completionTime property.
|
|
CONTINUEONERROR_PROPERTY
Use the property name to determine labels and converters for the
continueOnError property.
|
|
COPYRIGHT
(C) Copyright IBM Corporation 2004, 2012.
|
|
CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the
creationTime property.
|
|
CUSTOMPROPERTY_PROPERTY
Use the property name to determine labels and converters for the
customProperty property.
|
|
CUSTOMTEXT1_PROPERTY
Use the property name to determine labels and converters for the
customText1 property.
|
|
CUSTOMTEXT2_PROPERTY
Use the property name to determine labels and converters for the
customText2 property.
|
|
CUSTOMTEXT3_PROPERTY
Use the property name to determine labels and converters for the
customText3 property.
|
|
CUSTOMTEXT4_PROPERTY
Use the property name to determine labels and converters for the
customText4 property.
|
|
CUSTOMTEXT5_PROPERTY
Use the property name to determine labels and converters for the
customText5 property.
|
|
CUSTOMTEXT6_PROPERTY
Use the property name to determine labels and converters for the
customText6 property.
|
|
CUSTOMTEXT7_PROPERTY
Use the property name to determine labels and converters for the
customText7 property.
|
|
CUSTOMTEXT8_PROPERTY
Use the property name to determine labels and converters for the
customText8 property.
|
|
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the
description property.
|
|
DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the
displayName property.
|
|
EXCEPTIONMESSAGE_PROPERTY
Use the property name to determine labels and converters for the
exceptionMessage
property.
|
|
EXECUTIONSTATE_PROPERTY
Use the property name to determine labels and converters for the
executionState property.
|
|
FAULTNAME_PROPERTY
Use the property name to determine labels and converters for the
faultName property.
|
|
ID_PROPERTY
Use the property name to determine labels and converters for the
ID property.
|
|
INPUTMESSAGETPYENAME_PROPERTY
Use the property name to determine labels and converters for the
inputMessageTypeName property.
|
|
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
|
|
ISCOMPENSATIONDEFINED_PROPERTY
Use the property name to determine labels and converters for the
compensationDefined property.
|
|
LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the
lastModificationTime property.
|
|
LASTSTATECHANGETIME_PROPERTY
Use the property name to determine labels and converters for the
lastStateChange property.
|
|
MIGRATED_PROPERTY
Use the property name to determine labels and converters for the
Migrated property.
|
|
NAME_PROPERTY
Use the property name to determine labels and converters for the
name property.
|
|
OUTPUTMESSAGETPYENAME_PROPERTY
Use the property name to determine labels and converters for the
outputMessageTypeName property.
|
|
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Deprecated.
|
|
PARENTACTIVITYINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the
parentActivityInstanceID property.
|
|
PARENTPROCESSINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the
parentProcessInstanceID property.
|
|
PARENTPROCESSINSTANCENAME_PROPERTY
Use the property name to determine labels and converters for the
parentProcessInstanceName
property.
|
|
PROCESSADMINISTRATORS_PROPERTY
Use the property name to determine labels and converters for the
processAdministrators property.
|
|
PROCESSAPPACRONYM_PROPERTY
Use the property name to determine labels and converters for the
processAppAcronym property.
|
|
PROCESSAPPNAME_PROPERTY
Use the property name to determine labels and converters for the
processAppName property.
|
|
PROCESSTEMPLATEDISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the
processTemplateDisplayName property.
|
|
PROCESSTEMPLATEID_PROPERTY
Use the property name to determine labels and converters for the
processTemplateID property.
|
|
PROCESSTEMPLATENAME_PROPERTY
Use the property name to determine labels and converters for the
processTemplateName property.
|
|
RESUMPTIONTIME_PROPERTY
Use the property name to determine labels and converters for the
resumptionTime property.
|
|
SNAPSHOTID_PROPERTY
Use the property name to determine labels and converters for the
snapshotID property.
|
|
SNAPSHOTNAME_PROPERTY
Use the property name to determine labels and converters for the
snapshotName property.
|
|
STARTER_PROPERTY
Use the property name to determine labels and converters for the
starter property.
|
|
STARTTIME_PROPERTY
Use the property name to determine labels and converters for the
startTime property.
|
|
TIP_PROPERTY
Use the property name to determine labels and converters for the
tip property.
|
|
TOOLKITACRONYM_PROPERTY
Use the property name to determine labels and converters for the
toolkitAcronym property.
|
|
TOOLKITNAME_PROPERTY
Use the property name to determine labels and converters for the
toolkitName property.
|
|
TOOLKITSNAPSHOTID_PROPERTY
Use the property name to determine labels and converters for the
toolkitSnapshotID property.
|
|
TOOLKITSNAPSHOTNAME_PROPERTY
Use the property name to determine labels and converters for the
toolkitSnapshotName property.
|
|
TOPLEVELPROCESSINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the
topLevelProcessInstanceID property.
|
|
TOPLEVELPROCESSINSTANCENAME_PROPERTY
Use the property name to determine labels and converters for the
topLevelProcessInstanceName property.
|
|
TOPLEVELTOOLKITACRONYM_PROPERTY
Use the property name to determine labels and converters for the
topLevelToolkitAcronym property.
|
|
TOPLEVELTOOLKITNAME_PROPERTY
Use the property name to determine labels and converters for the
topLevelToolkitName property.
|
|
TRACKNAME_PROPERTY
Use the property name to determine labels and converters for the
trackName property.
|
|
UNHANDLEDEXCEPTION_PROPERTY
Use the property name to determine labels and converters for the
unhandledException
property.
|
|
VALIDFROMTIME_PROPERTY
Use the property name to determine labels and converters for the
validFromTime 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 |
---|---|
getAdminTaskID()
Returns the
adminTaskID property.
|
|
|
getAvailableActions()
Returns the
availableActions property.
|
|
getCompensationSphereName()
Returns the
compensationSphereName property.
|
|
getCompletionTime()
Returns the
completionTime property.
|
|
getConverter(java.lang.String propertyName)
Returns the default converter for a given property.
|
|
getCreationTime()
Returns the
creationTime property.
|
|
getCustomProperty(java.lang.String propertyName)
Returns the
customProperty property.
|
|
getCustomText1()
Returns the
customText1 property.
|
|
getCustomText2()
Returns the
customText2 property.
|
|
getCustomText3()
Returns the
customText3 property.
|
|
getCustomText4()
Returns the
customText4 property.
|
|
getCustomText5()
Returns the
customText5 property.
|
|
getCustomText6()
Returns the
customText6 property.
|
|
getCustomText7()
Returns the
customText7 property.
|
|
getCustomText8()
Returns the
customText8 property.
|
|
getDescription()
Returns the
description property.
|
|
getDisplayName()
Returns the
displayName property.
|
|
getExecutionState()
Returns the
executionState property.
|
getFaultMessageWrapper()
Retrieves the fault message.
|
|
|
getFaultName()
Returns the
faultName property.
|
getID()
Returns the
ID property.
|
|
|
getInputMessageTypeName()
Returns the
inputMessageTypeName property.
|
|
getInputMessageTypeTypeSystemName()
Deprecated.
|
getInputMessageWrapper()
Retrieves the input message.
|
|
|
getLabel(java.lang.String propertyName)
Returns the resource bundle key for a property
|
|
getLabel(java.lang.String propertyName,java.util.Locale locale)
Returns the label for a property from the resource bundle.
|
|
getLastModificationTime()
Returns the
lastModificationTime property.
|
|
getLastStateChangeTime()
Returns the
lastStateChangeTime property.
|
|
getName()
Returns the
name property.
|
|
getNamesOfCustomProperties()
Returns the
namesOfCustomProperties property.
|
|
getOutputMessageTypeName()
Returns the
outputMessageTypeName property.
|
|
getOutputMessageTypeTypeSystemName()
Deprecated.
|
getOutputMessageWrapper()
Retrieves the output message.
|
|
getParentActivityInstanceID()
Returns the
parentActivityInstanceID property.
|
|
getParentProcessInstanceID()
Returns the
parentProcessInstanceID property.
|
|
|
getParentProcessInstanceName()
Returns the
parentProcessInstanceName property.
|
getProcessAdministrators()
Returns the
processAdministrators property.
|
|
|
getProcessAppAcronym()
Returns the
processAppAcronym property.
|
|
getProcessAppName()
Returns the
processAppName property.
|
|
getProcessTemplateDisplayName()
Returns the
processTemplateDisplayName property.
|
getProcessTemplateID()
Returns the
processTemplateID property.
|
|
|
getProcessTemplateName()
Returns the
processTemplateName property.
|
|
getResumptionTime()
Returns the
resumptionTime property.
|
|
getSnapshotID()
Returns the
snapshotID property.
|
|
getSnapshotName()
Returns the
snapshotName property.
|
|
getStarter()
Returns the
starter property.
|
|
getStartTime()
Returns the
startTime property.
|
|
getToolkitAcronym()
Returns the
toolkitAcronym property.
|
|
getToolkitName()
Returns the
toolkitName property.
|
|
getToolkitSnapshotID()
Returns the
toolkitSnapshotID property.
|
|
getToolkitSnapshotName()
Returns the
toolkitSnapshotName property.
|
getTopLevelProcessInstanceID()
Returns the
topLevelProcessInstanceID property.
|
|
|
getTopLevelProcessInstanceName()
Returns the
topLevelProcessInstanceName property.
|
|
getTopLevelToolkitAcronym()
Returns the
topLevelToolkitAcronym property.
|
|
getTopLevelToolkitName()
Returns the
topLevelToolkitName property.
|
|
getTrackName()
Returns the
trackName property.
|
getUnhandledException()
Retrieves the unhandled exception.
|
|
|
getValidFromTime()
Returns the
validFromTime property.
|
|
isBusinessRelevant()
Returns the
businessRelevant property.
|
|
isCompensationDefined()
Returns the
compensationDefined property.
|
|
isContinueOnError()
Returns the
continueOnError property.
|
|
isMigrated()
|
|
isTip()
Returns the
isTip property.
|
|
isValid(java.lang.String propertyName)
Checks whether the property is valid.
|
|
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
AVAILABLEACTIONS_PROPERTY
- public static final java.lang.String AVAILABLEACTIONS_PROPERTY
applicationName
property.
COMPENSATIONSPHERENAME_PROPERTY
- public static final java.lang.String COMPENSATIONSPHERENAME_PROPERTY
compensationSphereName
property.
COMPLETIONTIME_PROPERTY
- public static final java.lang.String COMPLETIONTIME_PROPERTY
completionTime
property.
CONTINUEONERROR_PROPERTY
- public static final java.lang.String CONTINUEONERROR_PROPERTY
continueOnError
property.
RESUMPTIONTIME_PROPERTY
- public static final java.lang.String RESUMPTIONTIME_PROPERTY
resumptionTime
property.
CREATIONTIME_PROPERTY
- public static final java.lang.String CREATIONTIME_PROPERTY
creationTime
property.
CUSTOMPROPERTY_PROPERTY
- public static final java.lang.String CUSTOMPROPERTY_PROPERTY
customProperty
property.
DESCRIPTION_PROPERTY
- public static final java.lang.String DESCRIPTION_PROPERTY
description
property.
DISPLAYNAME_PROPERTY
- public static final java.lang.String DISPLAYNAME_PROPERTY
displayName
property.
EXECUTIONSTATE_PROPERTY
- public static final java.lang.String EXECUTIONSTATE_PROPERTY
executionState
property.
FAULTNAME_PROPERTY
- public static final java.lang.String FAULTNAME_PROPERTY
faultName
property.
ID_PROPERTY
- public static final java.lang.String ID_PROPERTY
ID
property.
ISCOMPENSATIONDEFINED_PROPERTY
- public static final java.lang.String ISCOMPENSATIONDEFINED_PROPERTY
compensationDefined
property.
INPUTMESSAGETPYENAME_PROPERTY
- public static final java.lang.String INPUTMESSAGETPYENAME_PROPERTY
inputMessageTypeName
property.
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
- public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
inputMessageTypeTypeSystemName
property.
LASTMODIFICATIONTIME_PROPERTY
- public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
lastModificationTime
property.
LASTSTATECHANGETIME_PROPERTY
- public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
lastStateChange
property.
MIGRATED_PROPERTY
- public static final java.lang.String MIGRATED_PROPERTY
Migrated
property.
NAME_PROPERTY
- public static final java.lang.String NAME_PROPERTY
name
property.
OUTPUTMESSAGETPYENAME_PROPERTY
- public static final java.lang.String OUTPUTMESSAGETPYENAME_PROPERTY
outputMessageTypeName
property.
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
- public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
outputMessageTypeTypeSystemName
property.
PROCESSADMINISTRATORS_PROPERTY
- public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
processAdministrators
property.
admard: since 7.0.0.2 no longer deprecated
PROCESSTEMPLATEID_PROPERTY
- public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
processTemplateID
property.
PROCESSTEMPLATENAME_PROPERTY
- public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
processTemplateName
property.
PROCESSTEMPLATEDISPLAYNAME_PROPERTY
- public static final java.lang.String PROCESSTEMPLATEDISPLAYNAME_PROPERTY
processTemplateDisplayName
property.
STARTER_PROPERTY
- public static final java.lang.String STARTER_PROPERTY
starter
property.
STARTTIME_PROPERTY
- public static final java.lang.String STARTTIME_PROPERTY
startTime
property.
TOPLEVELPROCESSINSTANCEID_PROPERTY
- public static final java.lang.String TOPLEVELPROCESSINSTANCEID_PROPERTY
topLevelProcessInstanceID
property.
TOPLEVELPROCESSINSTANCENAME_PROPERTY
- public static final java.lang.String TOPLEVELPROCESSINSTANCENAME_PROPERTY
topLevelProcessInstanceName
property.
PARENTPROCESSINSTANCEID_PROPERTY
- public static final java.lang.String PARENTPROCESSINSTANCEID_PROPERTY
parentProcessInstanceID
property.
PARENTACTIVITYINSTANCEID_PROPERTY
- public static final java.lang.String PARENTACTIVITYINSTANCEID_PROPERTY
parentActivityInstanceID
property.
PARENTPROCESSINSTANCENAME_PROPERTY
- public static final java.lang.String PARENTPROCESSINSTANCENAME_PROPERTY
parentProcessInstanceName
property.
UNHANDLEDEXCEPTION_PROPERTY
- public static final java.lang.String UNHANDLEDEXCEPTION_PROPERTY
unhandledException
property.
EXCEPTIONMESSAGE_PROPERTY
- public static final java.lang.String EXCEPTIONMESSAGE_PROPERTY
exceptionMessage
property.
VALIDFROMTIME_PROPERTY
- public static final java.lang.String VALIDFROMTIME_PROPERTY
validFromTime
property
SNAPSHOTID_PROPERTY
- public static final java.lang.String SNAPSHOTID_PROPERTY
snapshotID
property.
SNAPSHOTNAME_PROPERTY
- public static final java.lang.String SNAPSHOTNAME_PROPERTY
snapshotName
property.
TRACKNAME_PROPERTY
- public static final java.lang.String TRACKNAME_PROPERTY
trackName
property.
PROCESSAPPNAME_PROPERTY
- public static final java.lang.String PROCESSAPPNAME_PROPERTY
processAppName
property.
PROCESSAPPACRONYM_PROPERTY
- public static final java.lang.String PROCESSAPPACRONYM_PROPERTY
processAppAcronym
property.
TOOLKITSNAPSHOTID_PROPERTY
- public static final java.lang.String TOOLKITSNAPSHOTID_PROPERTY
toolkitSnapshotID
property.
TOOLKITSNAPSHOTNAME_PROPERTY
- public static final java.lang.String TOOLKITSNAPSHOTNAME_PROPERTY
toolkitSnapshotName
property.
TOOLKITNAME_PROPERTY
- public static final java.lang.String TOOLKITNAME_PROPERTY
toolkitName
property.
TOOLKITACRONYM_PROPERTY
- public static final java.lang.String TOOLKITACRONYM_PROPERTY
toolkitAcronym
property.
TOPLEVELTOOLKITNAME_PROPERTY
- public static final java.lang.String TOPLEVELTOOLKITNAME_PROPERTY
topLevelToolkitName
property.
TOPLEVELTOOLKITACRONYM_PROPERTY
- public static final java.lang.String TOPLEVELTOOLKITACRONYM_PROPERTY
topLevelToolkitAcronym
property.
TIP_PROPERTY
- public static final java.lang.String TIP_PROPERTY
tip
property.
CUSTOMTEXT1_PROPERTY
- public static final java.lang.String CUSTOMTEXT1_PROPERTY
customText1
property.
CUSTOMTEXT2_PROPERTY
- public static final java.lang.String CUSTOMTEXT2_PROPERTY
customText2
property.
CUSTOMTEXT3_PROPERTY
- public static final java.lang.String CUSTOMTEXT3_PROPERTY
customText3
property.
CUSTOMTEXT4_PROPERTY
- public static final java.lang.String CUSTOMTEXT4_PROPERTY
customText4
property.
CUSTOMTEXT5_PROPERTY
- public static final java.lang.String CUSTOMTEXT5_PROPERTY
customText5
property.
CUSTOMTEXT6_PROPERTY
- public static final java.lang.String CUSTOMTEXT6_PROPERTY
customText6
property.
CUSTOMTEXT7_PROPERTY
- public static final java.lang.String CUSTOMTEXT7_PROPERTY
customText7
property.
CUSTOMTEXT8_PROPERTY
- public static final java.lang.String CUSTOMTEXT8_PROPERTY
customText8
property.
Constructor Detail
ProcessInstanceBean
- public ProcessInstanceBean(ProcessInstanceData processInstance,
- BFMConnection bfmConnection)
ProcessInstanceBean
from an original
ProcessInstanceData
object.
processInstance
- The original data object. bfmConnection
- The connection to the BusinessFlowManagerService API. ProcessInstanceBean
- public ProcessInstanceBean(QueryResultSet resultSet,
- BFMConnection bfmConnection)
ProcessInstanceBean
from a
QueryResultSet
.
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)
ProcessInstanceBean
from a
QueryResultSet
.
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)
ProcessInstanceBean
from a process instance id
id
- The process instance id. bfmConnection
- The connection to the BusinessFlowManagerService API. Method Detail
getConverter
- public static SimpleConverter getConverter( java.lang.String propertyName)
propertyName
- The name of the property. propertyName
, null otherwise. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName)
propertyName
- The name of the property. getLabel
- public static java.lang.String getLabel( java.lang.String propertyName,
- java.util.Locale locale)
propertyName
- The name of the property. locale
- The locale. isValid
- public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked. propertyName
is a known property for an
object of this class. getAdminTaskID
- public TKIID getAdminTaskID()
adminTaskID
property.
getAdminTaskID
in interface ProcessInstanceData
getAvailableActions
- public int[] getAvailableActions( )
availableActions
property.
getAvailableActions
in interface ProcessInstanceData
getCompensationSphereName
- public java.lang.String getCompensationSphereName( )
compensationSphereName
property.
getCompensationSphereName
in interface ProcessInstanceData
getCompletionTime
- public java.util.Calendar getCompletionTime( )
completionTime
property.
getCompletionTime
in interface ProcessInstanceData
getResumptionTime
- public java.util.Calendar getResumptionTime( )
resumptionTime
property.
getResumptionTime
in interface ProcessInstanceData
getCreationTime
- public java.util.Calendar getCreationTime( )
creationTime
property.
getCreationTime
in interface ProcessInstanceData
getCustomProperty
- public java.lang.String getCustomProperty( java.lang.String propertyName)
customProperty
property.
getCustomProperty
in interface ProcessInstanceData
propertyName
- The name of the custom property for which the value is to be read. getDescription
- public java.lang.String getDescription( )
description
property.
getDescription
in interface ProcessInstanceData
getDisplayName
- public java.lang.String getDisplayName( )
displayName
property. Returns the
name
property when a display name is not assigned.
getDisplayName
in interface ProcessInstanceData
getExecutionState
- public int getExecutionState()
executionState
property.
getExecutionState
in interface ProcessInstanceData
getFaultName
- public java.lang.String getFaultName( )
faultName
property.
getFaultName
in interface ProcessInstanceData
getID
- public PIID getID()
ID
property.
getID
in interface ProcessInstanceData
getInputMessageTypeName
- public java.lang.String getInputMessageTypeName( )
inputMessageTypeName
property.
getInputMessageTypeName
in interface ProcessInstanceData
getInputMessageTypeTypeSystemName
- public java.lang.String getInputMessageTypeTypeSystemName( )
inputMessageTypeTypeSystemName
property.
getInputMessageTypeTypeSystemName
in interface ProcessInstanceData
getLastModificationTime
- public java.util.Calendar getLastModificationTime( )
lastModificationTime
property.
getLastModificationTime
in interface ProcessInstanceData
getLastStateChangeTime
- public java.util.Calendar getLastStateChangeTime( )
lastStateChangeTime
property.
getLastStateChangeTime
in interface ProcessInstanceData
getName
- public java.lang.String getName( )
name
property.
getName
in interface ProcessInstanceData
getNamesOfCustomProperties
- public java.util.List getNamesOfCustomProperties( )
namesOfCustomProperties
property.
getNamesOfCustomProperties
in interface ProcessInstanceData
getOutputMessageTypeName
- public java.lang.String getOutputMessageTypeName( )
outputMessageTypeName
property.
getOutputMessageTypeName
in interface ProcessInstanceData
getOutputMessageTypeTypeSystemName
- public java.lang.String getOutputMessageTypeTypeSystemName( )
outputMessageTypeTypeSystemName
property.
getOutputMessageTypeTypeSystemName
in interface ProcessInstanceData
getProcessAdministrators
- public StaffResultSet getProcessAdministrators( )
- throws WorkItemManagerException
- InvalidLengthException
processAdministrators
property.
getProcessAdministrators
in interface ProcessInstanceData
getProcessTemplateID
- public PTID getProcessTemplateID( )
processTemplateID
property.
getProcessTemplateID
in interface ProcessInstanceData
getProcessTemplateName
- public java.lang.String getProcessTemplateName( )
processTemplateName
property.
getProcessTemplateName
in interface ProcessInstanceData
getProcessTemplateDisplayName
- public java.lang.String getProcessTemplateDisplayName( )
processTemplateDisplayName
property. Returns
the processTemplateName
property when a display name is
not assigned.
getStarter
- public java.lang.String getStarter( )
starter
property.
getStarter
in interface ProcessInstanceData
getStartTime
- public java.util.Calendar getStartTime( )
startTime
property.
getStartTime
in interface ProcessInstanceData
getTopLevelProcessInstanceID
- public PIID getTopLevelProcessInstanceID( )
topLevelProcessInstanceID
property.
getTopLevelProcessInstanceID
in interface ProcessInstanceData
getTopLevelProcessInstanceName
- public java.lang.String getTopLevelProcessInstanceName( )
topLevelProcessInstanceName
property.
getTopLevelProcessInstanceName
in interface ProcessInstanceData
getParentProcessInstanceName
- public java.lang.String getParentProcessInstanceName( )
parentProcessInstanceName
property.
getParentProcessInstanceName
in interface ProcessInstanceData
getParentProcessInstanceID
- public PIID getParentProcessInstanceID( )
parentProcessInstanceID
property.
getParentProcessInstanceID
in interface ProcessInstanceData
getParentActivityInstanceID
- public AIID getParentActivityInstanceID( )
parentActivityInstanceID
property.
getParentActivityInstanceID
in interface ProcessInstanceData
getValidFromTime
- public java.util.Calendar getValidFromTime( )
validFromTime
property.
getValidFromTime
in interface ProcessInstanceData
getSnapshotID
- public java.lang.String getSnapshotID( )
snapshotID
property.
getSnapshotName
- public java.lang.String getSnapshotName( )
snapshotName
property.
getTrackName
- public java.lang.String getTrackName( )
trackName
property.
getProcessAppName
- public java.lang.String getProcessAppName( )
processAppName
property.
getProcessAppAcronym
- public java.lang.String getProcessAppAcronym( )
processAppAcronym
property.
getToolkitSnapshotID
- public java.lang.String getToolkitSnapshotID( )
toolkitSnapshotID
property.
getToolkitSnapshotName
- public java.lang.String getToolkitSnapshotName( )
toolkitSnapshotName
property.
getToolkitName
- public java.lang.String getToolkitName( )
toolkitName
property.
getToolkitAcronym
- public java.lang.String getToolkitAcronym( )
toolkitAcronym
property.
getTopLevelToolkitName
- public java.lang.String getTopLevelToolkitName( )
topLevelToolkitName
property.
getTopLevelToolkitAcronym
- public java.lang.String getTopLevelToolkitAcronym( )
topLevelToolkitAcronym
property.
isTip
- public boolean isTip()
isTip
property.
isBusinessRelevant
- public boolean isBusinessRelevant( )
businessRelevant
property.
isBusinessRelevant
in interface ProcessInstanceData
isCompensationDefined
- public boolean isCompensationDefined( )
compensationDefined
property.
isCompensationDefined
in interface ProcessInstanceData
setExecutionState
- public void setExecutionState(int state)
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
ProcessInstanceData
server objects may be different and the
object should therefore be refreshed if necessary.
state
- The new state of the process instance. getInputMessageWrapper
- public MessageWrapper getInputMessageWrapper( )
- throws ClientException
getOutputMessageWrapper
- public MessageWrapper getOutputMessageWrapper( )
- throws ClientException
getFaultMessageWrapper
- public MessageWrapper getFaultMessageWrapper( )
- throws ClientException
getUnhandledException
- public ProcessException getUnhandledException( )
getUnhandledException
in interface ProcessInstanceData
isContinueOnError
- public boolean isContinueOnError( )
continueOnError
property.
isContinueOnError
in interface ProcessInstanceData
isMigrated
- public boolean isMigrated()
ProcessInstanceData
isMigrated
in interface ProcessInstanceData
getCustomText1
- public java.lang.String getCustomText1( )
customText1
property.
getCustomText1
in interface ProcessInstanceData
getCustomText2
- public java.lang.String getCustomText2( )
customText2
property.
getCustomText2
in interface ProcessInstanceData
getCustomText3
- public java.lang.String getCustomText3( )
customText3
property.
getCustomText3
in interface ProcessInstanceData
getCustomText4
- public java.lang.String getCustomText4( )
customText4
property.
getCustomText4
in interface ProcessInstanceData
getCustomText5
- public java.lang.String getCustomText5( )
customText5
property.
getCustomText5
in interface ProcessInstanceData
getCustomText6
- public java.lang.String getCustomText6( )
customText6
property.
getCustomText6
in interface ProcessInstanceData
getCustomText7
- public java.lang.String getCustomText7( )
customText7
property.
getCustomText7
in interface ProcessInstanceData
getCustomText8
- public java.lang.String getCustomText8( )
customText8
property.
getCustomText8
in interface ProcessInstanceData