|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.clientmodel.bean.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 a QueryResultSet
object
or from an ProcessInstanceData
object.
If the bean was instantiated from an original object returned by the Business Process
Choreographer API, all properties are loaded. If the bean is instantiated from a query
only the following properties are going to be loaded from the query result set:
ID
name
processTemplateName
executionState
startTime
starter
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 may be null because 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 property applicationName . |
static java.lang.String |
COMPENSATIONSPHERENAME_PROPERTY
Use the property name to determine labels and converters for the property compensationSphereName . |
static java.lang.String |
COMPLETIONTIME_PROPERTY
Use the property name to determine labels and converters for the property completionTime . |
static java.lang.String |
COPYRIGHT
(C) Copyright IBM Corporation 2004, 2005. |
static java.lang.String |
CREATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property creationTime . |
static java.lang.String |
CUSTOMPROPERTY_PROPERTY
Use the property name to determine labels and converters for the property customProperty . |
static java.lang.String |
DESCRIPTION_PROPERTY
Use the property name to determine labels and converters for the property description . |
static java.lang.String |
DISPLAYNAME_PROPERTY
Use the property name to determine labels and converters for the property displayName . |
static java.lang.String |
EXECUTIONSTATE_PROPERTY
Use the property name to determine labels and converters for the property executionState . |
static java.lang.String |
FAULTNAME_PROPERTY
Use the property name to determine labels and converters for the property faultName . |
static java.lang.String |
ID_PROPERTY
Use the property name to determine labels and converters for the property ID . |
static java.lang.String |
INPUTMESSAGETPYENAME_PROPERTY
Use the property name to determine labels and converters for the property inputMessageTypeName . |
static java.lang.String |
INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Use the property name to determine labels and converters for the property inputMessageTypeTypeSystemName . |
static java.lang.String |
ISCOMPENSATIONDEFINED_PROPERTY
Use the property name to determine labels and converters for the property compensationDefined . |
static java.lang.String |
LASTMODIFICATIONTIME_PROPERTY
Use the property name to determine labels and converters for the property lastModificationTime . |
static java.lang.String |
LASTSTATECHANGETIME_PROPERTY
Use the property name to determine labels and converters for the property lastStateChange . |
static java.lang.String |
NAME_PROPERTY
Use the property name to determine labels and converters for the property name . |
static java.lang.String |
OUTPUTMESSAGETPYENAME_PROPERTY
Use the property name to determine labels and converters for the property outputMessageTypeName . |
static java.lang.String |
OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
Use the property name to determine labels and converters for the property outputMessageTypeTypeSystemName . |
static java.lang.String |
PROCESSADMINISTRATORS_PROPERTY
Use the property name to determine labels and converters for the property processAdministrators . |
static java.lang.String |
PROCESSTEMPLATEID_PROPERTY
Use the property name to determine labels and converters for the property processTemplateID . |
static java.lang.String |
PROCESSTEMPLATENAME_PROPERTY
Use the property name to determine labels and converters for the property processTemplateName . |
static java.lang.String |
STARTER_PROPERTY
Use the property name to determine labels and converters for the property starter . |
static java.lang.String |
STARTTIME_PROPERTY
Use the property name to determine labels and converters for the property startTime . |
static java.lang.String |
TOPLEVELPROCESSINSTANCEID_PROPERTY
Use the property name to determine labels and converters for the property topLevelProcessInstanceID . |
static java.lang.String |
TOPLEVELPROCESSINSTANCENAME_PROPERTY
Use the property name to determine labels and converters for the property topLevelProcessInstanceName . |
Fields inherited from interface com.ibm.bpe.api.ProcessInstanceData |
---|
STATE_COMPENSATED, STATE_COMPENSATING, STATE_COMPENSATION_FAILED, STATE_FAILED, STATE_FAILING, STATE_FINISHED, STATE_INDOUBT, STATE_READY, STATE_RUNNING, STATE_SUSPENDED, STATE_TERMINATED, STATE_TERMINATING |
Constructor Summary | |
---|---|
ProcessInstanceBean(com.ibm.bpe.api.ProcessInstanceData processInstance,
BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from an original ProcessInstanceData object. |
|
ProcessInstanceBean(com.ibm.bpe.api.QueryResultSet resultSet,
BFMConnection bfmConnection)
Constructs a new ProcessInstanceBean from a QueryResultSet . |
Method Summary | |
---|---|
com.ibm.task.api.TKIID |
getAdminTaskID()
Returns the property adminTaskID . |
int[] |
getAvailableActions()
Returns the property availableActions . |
java.lang.String |
getCompensationSphereName()
Returns the property compensationSphereName . |
java.util.Calendar |
getCompletionTime()
Returns the property completionTime . |
static SimpleConverter |
getConverter(java.lang.String propertyName)
Returns the default converter for a given property. |
java.util.Calendar |
getCreationTime()
Returns the property creationTime . |
java.lang.String |
getCustomProperty(java.lang.String propertyName)
Returns the property customProperty . |
java.lang.String |
getDescription()
Returns the property description . |
java.lang.String |
getDisplayName()
Returns the property displayName . |
int |
getExecutionState()
Returns the property executionState . |
MessageWrapper |
getFaultMessageWrapper()
Retrieves the fault message. |
java.lang.String |
getFaultName()
Returns the property faultName . |
com.ibm.bpe.api.PIID |
getID()
Returns the property ID . |
java.lang.String |
getInputMessageTypeName()
Returns the property inputMessageTypeName . |
java.lang.String |
getInputMessageTypeTypeSystemName()
Returns the property inputMessageTypeTypeSystemName . |
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 property lastModificationTime . |
java.util.Calendar |
getLastStateChangeTime()
Returns the property lastStateChangeTime . |
java.lang.String |
getName()
Returns the property name . |
java.util.List |
getNamesOfCustomProperties()
Returns the property namesOfCustomProperties . |
java.lang.String |
getOutputMessageTypeName()
Returns the property outputMessageTypeName . |
java.lang.String |
getOutputMessageTypeTypeSystemName()
Returns the property outputMessageTypeTypeSystemName . |
MessageWrapper |
getOutputMessageWrapper()
Retrieves the output message. |
com.ibm.bpe.api.StaffResultSet |
getProcessAdministrators()
Returns the property processAdministrators . |
com.ibm.bpe.api.PTID |
getProcessTemplateID()
Returns the property processTemplateID . |
java.lang.String |
getProcessTemplateName()
Returns the property processTemplateName . |
java.lang.String |
getStarter()
Returns the property starter . |
java.util.Calendar |
getStartTime()
Returns the property startTime . |
com.ibm.bpe.api.PIID |
getTopLevelProcessInstanceID()
Returns the property topLevelProcessInstanceID . |
java.lang.String |
getTopLevelProcessInstanceName()
Returns the property topLevelProcessInstanceName . |
java.util.Calendar |
getValidFromTime()
Returns the property validFromTime . |
boolean |
isBusinessRelevant()
Returns the property businessRelevant . |
boolean |
isCompensationDefined()
Returns the property compensationDefined . |
static boolean |
isValid(java.lang.String propertyName)
Checks if the property is valid. |
void |
setExecutionState(int state)
Changes the property executionState 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
public static final java.lang.String COMPENSATIONSPHERENAME_PROPERTY
public static final java.lang.String COMPLETIONTIME_PROPERTY
public static final java.lang.String CREATIONTIME_PROPERTY
public static final java.lang.String CUSTOMPROPERTY_PROPERTY
public static final java.lang.String DESCRIPTION_PROPERTY
public static final java.lang.String DISPLAYNAME_PROPERTY
public static final java.lang.String EXECUTIONSTATE_PROPERTY
public static final java.lang.String FAULTNAME_PROPERTY
public static final java.lang.String ID_PROPERTY
public static final java.lang.String INPUTMESSAGETPYENAME_PROPERTY
public static final java.lang.String INPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
public static final java.lang.String ISCOMPENSATIONDEFINED_PROPERTY
public static final java.lang.String LASTMODIFICATIONTIME_PROPERTY
public static final java.lang.String LASTSTATECHANGETIME_PROPERTY
public static final java.lang.String NAME_PROPERTY
public static final java.lang.String OUTPUTMESSAGETPYENAME_PROPERTY
public static final java.lang.String OUTPUTMESSAGETYPETYPESYSTEMNAME_PROPERTY
public static final java.lang.String PROCESSADMINISTRATORS_PROPERTY
public static final java.lang.String PROCESSTEMPLATEID_PROPERTY
public static final java.lang.String PROCESSTEMPLATENAME_PROPERTY
public static final java.lang.String STARTER_PROPERTY
public static final java.lang.String STARTTIME_PROPERTY
public static final java.lang.String TOPLEVELPROCESSINSTANCEID_PROPERTY
public static final java.lang.String TOPLEVELPROCESSINSTANCENAME_PROPERTY
Constructor Detail |
public ProcessInstanceBean(com.ibm.bpe.api.ProcessInstanceData processInstance, BFMConnection bfmConnection)
ProcessInstanceBean
from an original ProcessInstanceData
object.
processInstance
- The original data object.bfmConnection
- The connection to the BusinessFlowManagerService API.public ProcessInstanceBean(com.ibm.bpe.api.QueryResultSet resultSet, BFMConnection bfmConnection)
ProcessInstanceBean
from a QueryResultSet
.
resultSet
- The result object of a query.bfmConnection
- The connection to the BusinessFlowManagerService API.Method Detail |
public static SimpleConverter getConverter(java.lang.String propertyName)
propertyName
- The name for the property.
public static java.lang.String getLabel(java.lang.String propertyName)
propertyName
- The name for the property.
public static java.lang.String getLabel(java.lang.String propertyName, java.util.Locale locale)
propertyName
- The name for the property.locale
- The locale.
public static boolean isValid(java.lang.String propertyName)
propertyName
- The name of the property to be checked.
public com.ibm.task.api.TKIID getAdminTaskID()
adminTaskID
.
getAdminTaskID
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getAdminTaskID()
public int[] getAvailableActions()
availableActions
.
getAvailableActions
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getAvailableActions()
public java.lang.String getCompensationSphereName()
compensationSphereName
.
getCompensationSphereName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getCompensationSphereName()
public java.util.Calendar getCompletionTime()
completionTime
.
getCompletionTime
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getCompletionTime()
public java.util.Calendar getCreationTime()
creationTime
.
getCreationTime
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getCreationTime()
public java.lang.String getCustomProperty(java.lang.String propertyName)
customProperty
.
getCustomProperty
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getCustomProperty(java.lang.String)
public java.lang.String getDescription()
description
.
getDescription
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getDescription()
public java.lang.String getDisplayName()
displayName
.
getDisplayName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getDisplayName()
public int getExecutionState()
executionState
.
getExecutionState
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getExecutionState()
public java.lang.String getFaultName()
faultName
.
getFaultName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getFaultName()
public com.ibm.bpe.api.PIID getID()
ID
.
getID
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getID()
public java.lang.String getInputMessageTypeName()
inputMessageTypeName
.
getInputMessageTypeName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getInputMessageTypeName()
public java.lang.String getInputMessageTypeTypeSystemName()
inputMessageTypeTypeSystemName
.
getInputMessageTypeTypeSystemName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getInputMessageTypeTypeSystemName()
public java.util.Calendar getLastModificationTime()
lastModificationTime
.
getLastModificationTime
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getLastModificationTime()
public java.util.Calendar getLastStateChangeTime()
lastStateChangeTime
.
getLastStateChangeTime
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getLastStateChangeTime()
public java.lang.String getName()
name
.
getName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getName()
public java.util.List getNamesOfCustomProperties()
namesOfCustomProperties
.
getNamesOfCustomProperties
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getNamesOfCustomProperties()
public java.lang.String getOutputMessageTypeName()
outputMessageTypeName
.
getOutputMessageTypeName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getOutputMessageTypeName()
public java.lang.String getOutputMessageTypeTypeSystemName()
outputMessageTypeTypeSystemName
.
getOutputMessageTypeTypeSystemName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getOutputMessageTypeTypeSystemName()
public com.ibm.bpe.api.StaffResultSet getProcessAdministrators() throws com.ibm.bpe.api.WorkItemManagerException, com.ibm.bpe.api.InvalidLengthException
processAdministrators
.
getProcessAdministrators
in interface com.ibm.bpe.api.ProcessInstanceData
com.ibm.bpe.api.WorkItemManagerException
com.ibm.bpe.api.InvalidLengthException
ProcessInstanceData.getProcessAdministrators()
public com.ibm.bpe.api.PTID getProcessTemplateID()
processTemplateID
.
getProcessTemplateID
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getProcessTemplateID()
public java.lang.String getProcessTemplateName()
processTemplateName
.
getProcessTemplateName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getProcessTemplateName()
public java.lang.String getStarter()
starter
.
getStarter
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getStarter()
public java.util.Calendar getStartTime()
startTime
.
getStartTime
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getStartTime()
public com.ibm.bpe.api.PIID getTopLevelProcessInstanceID()
topLevelProcessInstanceID
.
getTopLevelProcessInstanceID
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getTopLevelProcessInstanceID()
public java.lang.String getTopLevelProcessInstanceName()
topLevelProcessInstanceName
.
getTopLevelProcessInstanceName
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getTopLevelProcessInstanceName()
public java.util.Calendar getValidFromTime()
validFromTime
.
getValidFromTime
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.getValidFromTime()
public boolean isBusinessRelevant()
businessRelevant
.
isBusinessRelevant
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.isBusinessRelevant()
public boolean isCompensationDefined()
compensationDefined
.
isCompensationDefined
in interface com.ibm.bpe.api.ProcessInstanceData
ProcessInstanceData.isCompensationDefined()
public void setExecutionState(int state)
executionState
of the process instance.
This may happen for example when aprocess instance was terminated, suspended or restarted
through the BPC Explorer.
ProcessInstanceBean
object and
the ProcessInstanceData
server object may differ
and the object should 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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |