MessageMappingResponseCmd

Skip navigation links

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

com.ibm.websphere.command.Command, java.io.Serializable

All Known Implementing Classes:

AbstractMemberResponseBaseCmdImpl, AcknowledgeAttachmentBuildCmdImpl, AcknowledgeAttachmentErrorBuildCmdImpl, AcknowledgeManagedDirectoryBuildCmdImpl, AcknowledgeManagedDirectoryErrorBuildCmdImpl, AcknowledgeManagedFileBuildCmdImpl, AcknowledgeOrderBuildCmdImpl, AcknowledgeOrderBuildForCalculationCmdImpl, AcknowledgeOrderErrorBuildCmdImpl, AcknowledgeOrganizationCmdImpl, AcknowledgePersonCmdImpl, AcknowledgePersonCreateGuestCmdImpl, AttachmentResponseBuildBaseCmdImpl, ConfirmBODResponseCmdImpl, ManagedDirectoryResponseBuildBaseCmdImpl, ManagedFileResponseBuildBaseCmdImpl, OrderResponseBuildBaseCmdImpl, RespondOrderBuildCmdImpl, RespondOrderErrorBuildCmdImpl, RespondOrderWithPIBuildCmdImpl, RespondOrganizationCmdImpl, RespondPersonCmdImpl
```
public interface MessageMappingResponseCmd
extends com.ibm.websphere.command.Command
```
This interface is used by the message mapping command to build the response business object document. The implementation of this interface is given the controller command executed and the associated exception. When the command is executed, it should use these pieces of information to return the appropriate business object document response object.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM Copyright notice field.
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BusinessObjectDocumentType`	`getBusinessObjectDocument()` This method will return the resulting business object document that represents the controller command executed and if present, the associated exception.
`void`	`setControllerCommand(ControllerCommand controllerCommand)` This method is called to set the controller command implementation that was executed.
`void`	`setException(java.lang.Exception exception)` This method is called to set the associated exception that occurred during executing the controller command.

Methods inherited from interface com.ibm.websphere.command.Command
execute, isReadyToCallExecute, reset

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM Copyright notice field.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setControllerCommand
```
void setControllerCommand(ControllerCommand controllerCommand)
```
    This method is called to set the controller command implementation that was executed.
    
    Parameters:
    
    controllerCommand - The executed controller command.
  - setException
```
void setException(java.lang.Exception exception)
```
    This method is called to set the associated exception that occurred during executing the controller command.
    
    Parameters:
    
    exception - The associated application exception that helps to create the error information in the response business object document.
  - getBusinessObjectDocument
```
BusinessObjectDocumentType getBusinessObjectDocument()
```
    This method will return the resulting business object document that represents the controller command executed and if present, the associated exception.
    
    Returns:
    
    The response business object document.