BusinessFlowCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Known Implementing Classes:

BusinessFlowCmdImpl, ContractSubmitPostApprovalCmdImpl, ContractSubmitPostCancelCmdImpl, ContractSubmitPostRejectCmdImpl, ContractSubmitPreApprovalCmdImpl, ContractSubmitResponseCmdImpl, ToolsBusinessFlowCmdImpl
```
public interface BusinessFlowCmd
```
Any command that needs to use UBF to control a business process must implement this interface. This interface will allow communication between a command and the BusinessFlowEventListener. UBF can get the Id of an object after the object is created by a command for the first time, and UBF also can tell a command what state an object is supposed to be in after the command is successfully executed.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getEntityId()` Get the ID of an object after the object is created by a command for the first time.
`BusinessFlowEntityBean`	`getEntityObject()` Get the entity object from command if this is a new process.
`java.lang.String`	`getFlowContext()` Get the flow context which is set up by the action cmd and to be stored into the FLINSTANCE table by UBF.
`void`	`setFlowContext(java.lang.String aFlowContext)` Set the flow context which is retrieved from the FLINSTANCE table by UBF and make it availabel for the action cmd.
`void`	`setStateIdentifier(java.lang.Integer aStateIdentifier)` UBF informs the command the state of the entity.

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getEntityId
```
java.lang.Long getEntityId()
```
    Get the ID of an object after the object is created by a command for the first time.
    
    Returns:
    
    The Id of an object.
  - getEntityObject
```
BusinessFlowEntityBean getEntityObject()
```
    Get the entity object from command if this is a new process. This will improve performance of the system.
    
    Returns:
    
    The business flow entity bean object.
  - getFlowContext
```
java.lang.String getFlowContext()
```
    Get the flow context which is set up by the action cmd and to be stored into the FLINSTANCE table by UBF. This method will be called after the action cmd of a transition is executed.
    
    Returns:
    
    flow context.
  - setFlowContext
```
void setFlowContext(java.lang.String aFlowContext)
```
    Set the flow context which is retrieved from the FLINSTANCE table by UBF and make it availabel for the action cmd. This method will be called before the action cmd of a transition is executed.
    
    Parameters:
    
    aFlowContext - The flow context is stored by UBF.
  - setStateIdentifier
```
void setStateIdentifier(java.lang.Integer aStateIdentifier)
```
    UBF informs the command the state of the entity.
    
    Parameters:
    
    aStateIdentifier - The state identifier.