com.ibm.commerce.foundation.server.command.soi

Class ConfirmBODResponseCmdImpl

  • java.lang.Object
    • com.ibm.commerce.foundation.server.command.soi.ConfirmBODResponseCmdImpl
  • All Implemented Interfaces:
    MessageMappingResponseCmd, com.ibm.websphere.command.Command, java.io.Serializable


    public class ConfirmBODResponseCmdImpl
    extends java.lang.Object
    implements MessageMappingResponseCmd
    This command is used to convert a successful or error response of a controller command to a Confirm BOD response. Any Sync type of controller command can use this response command for creating the response. The result of this command is a ConfirmBOD object that will contain the error information in the case of an exception. In the case where the command executes successfully, no error information is required.
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID
    • Constructor Summary

      Constructors 
      Constructor and Description
      ConfirmBODResponseCmdImpl()
      Creates an instance of the ConfirmBOD response command.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void execute()
      Creates the confirm business object document based on the controller command and the exception specified.
      BusinessObjectDocumentType getBusinessObjectDocument()
      This method returns the ConfirmBOD object that represents the request execution.
      boolean isReadyToCallExecute()
      This method returns whether the command can be executed.
      void reset()
      This method resets the instance variables of the command.
      void setControllerCommand(ControllerCommand controllerCommand)
      This method sets the controller command associated with creating the Confirm response.
      void setException(java.lang.Exception exception)
      This method sets the exception that resulted when executing the request.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ConfirmBODResponseCmdImpl

        public ConfirmBODResponseCmdImpl()
        Creates an instance of the ConfirmBOD response command.
    • Method Detail

      • execute

        public void execute()
                     throws com.ibm.websphere.command.CommandException
        Creates the confirm business object document based on the controller command and the exception specified.
        Specified by:
        execute in interface com.ibm.websphere.command.Command
        Throws:
        com.ibm.websphere.command.CommandException
        See Also:
        Command.execute()
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        This method returns whether the command can be executed.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Returns:
        true is returned in the controller command has been set, otherwise false.
        See Also:
        Command.isReadyToCallExecute()
      • reset

        public void reset()
        This method resets the instance variables of the command.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        See Also:
        Command.reset()