|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.clientmodel.bean.ProcessInstanceBean
public class ProcessInstanceBean
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.
ProcessInstanceData
,
QueryResultSet
,
Serialized FormField 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, 2010. |
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 |
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 the exceptionMessage
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 the parentProcessInstanceName
property. |
static java.lang.String |
PROCESSADMINISTRATORS_PROPERTY
Deprecated. |
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 |
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 |
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 |
UNHANDLEDEXCEPTION_PROPERTY
Use the property name to determine labels and converters for the unhandledException
property. |
static java.lang.String |
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 | |
---|---|
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 |
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()
Deprecated. |
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 |
getStarter()
Returns the starter property. |
java.util.Calendar |
getStartTime()
Returns the startTime property. |
PIID |
getTopLevelProcessInstanceID()
Returns the topLevelProcessInstanceID property. |
java.lang.String |
getTopLevelProcessInstanceName()
Returns the topLevelProcessInstanceName 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. |
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 |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String AVAILABLEACTIONS_PROPERTY
applicationName
property.
public static final java.lang.String COMPENSATIONSPHERENAME_PROPERTY
compensationSphereName
property.
public static final java.lang.String COMPLETIONTIME_PROPERTY
completionTime
property.
public static final java.lang.String CONTINUEONERROR_PROPERTY
continueOnError
property.
public static final java.lang.String RESUMPTIONTIME_PROPERTY
resumptionTime
property.
public static final java.lang.String CREATIONTIME_PROPERTY
creationTime
property.
public static final java.lang.String CUSTOMPROPERTY_PROPERTY
customProperty
property.
public static final java.lang.String DESCRIPTION_PROPERTY
description
property.
public static final java.lang.String DISPLAYNAME_PROPERTY
displayName
property.
public static final java.lang.String EXECUTIONSTATE_PROPERTY
executionState
property.
public static final java.lang.String FAULTNAME_PROPERTY
faultName
property.
public static final java.lang.String ID_PROPERTY
ID
property.
public static final java.lang.String ISCOMPENSATIONDEFINED_PROPERTY
compensationDefined
property.
public static final java.lang.String INPUTMESSAGETPYENAME_PROPERTY
inputMessageTypeName
property.
public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
inputMessageTypeTypeSystemName
property.
public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
lastModificationTime
property.
public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
lastStateChange
property.
public static final java.lang.String MIGRATED_PROPERTY
Migrated
property.
public static final java.lang.String NAME_PROPERTY
name
property.
public static final java.lang.String OUTPUTMESSAGETPYENAME_PROPERTY
outputMessageTypeName
property.
public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
outputMessageTypeTypeSystemName
property.
public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
processAdministrators
property.
public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
processTemplateID
property.
public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
processTemplateName
property.
public static final java.lang.String PROCESSTEMPLATEDISPLAYNAME_PROPERTY
processTemplateDisplayName
property.
public static final java.lang.String STARTER_PROPERTY
starter
property.
public static final java.lang.String STARTTIME_PROPERTY
startTime
property.
public static final java.lang.String TOPLEVELPROCESSINSTANCEID_PROPERTY
topLevelProcessInstanceID
property.
public static final java.lang.String TOPLEVELPROCESSINSTANCENAME_PROPERTY
topLevelProcessInstanceName
property.
public static final java.lang.String PARENTPROCESSINSTANCEID_PROPERTY
parentProcessInstanceID
property.
public static final java.lang.String PARENTACTIVITYINSTANCEID_PROPERTY
parentActivityInstanceID
property.
public static final java.lang.String PARENTPROCESSINSTANCENAME_PROPERTY
parentProcessInstanceName
property.
public static final java.lang.String UNHANDLEDEXCEPTION_PROPERTY
unhandledException
property.
public static final java.lang.String EXCEPTIONMESSAGE_PROPERTY
exceptionMessage
property.
public static final java.lang.String VALIDFROMTIME_PROPERTY
validFromTime
property
Constructor Detail |
---|
public ProcessInstanceBean(ProcessInstanceData processInstance, BFMConnection bfmConnection)
ProcessInstanceBean
from an original
ProcessInstanceData
object.
processInstance
- The original data object.bfmConnection
- The connection to the BusinessFlowManagerService API.public ProcessInstanceBean(QueryResultSet resultSet, BFMConnection bfmConnection)
ProcessInstanceBean
from a
QueryResultSet
.
resultSet
- The result object of a query.bfmConnection
- The connection to the BusinessFlowManagerService API.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
attributesbfmConnection
- The connection to the BusinessFlowManagerService API.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 |
---|
public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name of the property.
propertyName
, null otherwise.public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name of the property.
public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name of the property.locale
- The locale.
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.public TKIID getAdminTaskID()
adminTaskID
property.
getAdminTaskID
in interface ProcessInstanceData
ProcessInstanceData.getAdminTaskID()
public int[] getAvailableActions()
availableActions
property.
getAvailableActions
in interface ProcessInstanceData
ProcessInstanceData.getAvailableActions()
public java.lang.String getCompensationSphereName()
compensationSphereName
property.
getCompensationSphereName
in interface ProcessInstanceData
ProcessInstanceData.getCompensationSphereName()
public java.util.Calendar getCompletionTime()
completionTime
property.
getCompletionTime
in interface ProcessInstanceData
ProcessInstanceData.getCompletionTime()
public java.util.Calendar getResumptionTime()
resumptionTime
property.
getResumptionTime
in interface ProcessInstanceData
ProcessInstanceData.getResumptionTime()
public java.util.Calendar getCreationTime()
creationTime
property.
getCreationTime
in interface ProcessInstanceData
ProcessInstanceData.getCreationTime()
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.ProcessInstanceData.getCustomProperty(java.lang.String)
public java.lang.String getDescription()
description
property.
getDescription
in interface ProcessInstanceData
ProcessInstanceData.getDescription()
public java.lang.String getDisplayName()
displayName
property. Returns the
name
property when a display name is not assigned.
getDisplayName
in interface ProcessInstanceData
ProcessInstanceData.getDisplayName()
public int getExecutionState()
executionState
property.
getExecutionState
in interface ProcessInstanceData
ProcessInstanceData.getExecutionState()
public java.lang.String getFaultName()
faultName
property.
getFaultName
in interface ProcessInstanceData
ProcessInstanceData.getFaultName()
public PIID getID()
ID
property.
getID
in interface ProcessInstanceData
ProcessInstanceData.getID()
public java.lang.String getInputMessageTypeName()
inputMessageTypeName
property.
getInputMessageTypeName
in interface ProcessInstanceData
ProcessInstanceData.getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
inputMessageTypeTypeSystemName
property.
getInputMessageTypeTypeSystemName
in interface ProcessInstanceData
ProcessInstanceData.getInputMessageTypeTypeSystemName()
public java.util.Calendar getLastModificationTime()
lastModificationTime
property.
getLastModificationTime
in interface ProcessInstanceData
ProcessInstanceData.getLastModificationTime()
public java.util.Calendar getLastStateChangeTime()
lastStateChangeTime
property.
getLastStateChangeTime
in interface ProcessInstanceData
ProcessInstanceData.getLastStateChangeTime()
public java.lang.String getName()
name
property.
getName
in interface ProcessInstanceData
ProcessInstanceData.getName()
public java.util.List getNamesOfCustomProperties()
namesOfCustomProperties
property.
getNamesOfCustomProperties
in interface ProcessInstanceData
ProcessInstanceData.getNamesOfCustomProperties()
public java.lang.String getOutputMessageTypeName()
outputMessageTypeName
property.
getOutputMessageTypeName
in interface ProcessInstanceData
ProcessInstanceData.getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
outputMessageTypeTypeSystemName
property.
getOutputMessageTypeTypeSystemName
in interface ProcessInstanceData
ProcessInstanceData.getOutputMessageTypeTypeSystemName()
public StaffResultSet getProcessAdministrators() throws WorkItemManagerException, InvalidLengthException
processAdministrators
property.
getProcessAdministrators
in interface ProcessInstanceData
WorkItemManagerException
InvalidLengthException
ProcessInstanceData.getProcessAdministrators()
public PTID getProcessTemplateID()
processTemplateID
property.
getProcessTemplateID
in interface ProcessInstanceData
ProcessInstanceData.getProcessTemplateID()
public java.lang.String getProcessTemplateName()
processTemplateName
property.
getProcessTemplateName
in interface ProcessInstanceData
ProcessInstanceData.getProcessTemplateName()
public java.lang.String getProcessTemplateDisplayName()
processTemplateDisplayName
property. Returns
the processTemplateName
property when a display name is
not assigned.
public java.lang.String getStarter()
starter
property.
getStarter
in interface ProcessInstanceData
ProcessInstanceData.getStarter()
public java.util.Calendar getStartTime()
startTime
property.
getStartTime
in interface ProcessInstanceData
ProcessInstanceData.getStartTime()
public PIID getTopLevelProcessInstanceID()
topLevelProcessInstanceID
property.
getTopLevelProcessInstanceID
in interface ProcessInstanceData
ProcessInstanceData.getTopLevelProcessInstanceID()
public java.lang.String getTopLevelProcessInstanceName()
topLevelProcessInstanceName
property.
getTopLevelProcessInstanceName
in interface ProcessInstanceData
ProcessInstanceData.getTopLevelProcessInstanceName()
public java.lang.String getParentProcessInstanceName()
parentProcessInstanceName
property.
getParentProcessInstanceName
in interface ProcessInstanceData
ProcessInstanceData.getParentProcessInstanceName()
public PIID getParentProcessInstanceID()
parentProcessInstanceID
property.
getParentProcessInstanceID
in interface ProcessInstanceData
ProcessInstanceData.getParentProcessInstanceID()
public AIID getParentActivityInstanceID()
parentActivityInstanceID
property.
getParentActivityInstanceID
in interface ProcessInstanceData
ProcessInstanceData.getParentActivityInstanceID()
public java.util.Calendar getValidFromTime()
validFromTime
property.
getValidFromTime
in interface ProcessInstanceData
ProcessInstanceData.getValidFromTime()
public boolean isBusinessRelevant()
businessRelevant
property.
isBusinessRelevant
in interface ProcessInstanceData
ProcessInstanceData.isBusinessRelevant()
public boolean isCompensationDefined()
compensationDefined
property.
isCompensationDefined
in interface ProcessInstanceData
ProcessInstanceData.isCompensationDefined()
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. 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.public MessageWrapper getInputMessageWrapper() throws ClientException
ClientException
public MessageWrapper getOutputMessageWrapper() throws ClientException
ClientException
public MessageWrapper getFaultMessageWrapper() throws ClientException
ClientException
public ProcessException getUnhandledException()
getUnhandledException
in interface ProcessInstanceData
public boolean isContinueOnError()
continueOnError
property.
isContinueOnError
in interface ProcessInstanceData
ProcessTemplateData.isContinueOnError()
public boolean isMigrated()
ProcessInstanceData
isMigrated
in interface ProcessInstanceData
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |