com.ibm.commerce.payment.commands
Class GetOrderDescCmdImpl

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.TaskCommandImpl
              |
              +--com.ibm.commerce.payment.commands.GetOrderDescCmdImpl
All Implemented Interfaces:
ECCommand, GetOrderDescCmd, TaskCommand

public class GetOrderDescCmdImpl
extends TaskCommandImpl
implements GetOrderDescCmd

This GetOrderDescCmd Task Command implementation constructs a human readable description of the order suitable for display by a wallet application that runs on the shopper's machine.


Fields inherited from class com.ibm.commerce.command.AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.payment.commands.GetOrderDescCmd
COPYRIGHT, defaultCommandClassName, NAME
 
Constructor Summary
GetOrderDescCmdImpl()
           
 
Method Summary
protected  java.lang.Long getOrderId()
           
 byte[] getReturnData()
          Returns the byte Array containing the detail description of the order suitable for display by a wallet application running on the shopper's machine.
 boolean isReadyToCallExecute()
          This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command.
 void performExecute()
          Performs the main business logic of the command.
 void reset()
          Resets the instance variables of the command.
 void setOrderId(java.lang.Long orderId)
          Sets the orderId property of the command.
protected  void setReturnData(byte[] ba)
           
 
Methods inherited from class com.ibm.commerce.command.AbstractECCommand
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Constructor Detail

GetOrderDescCmdImpl

public GetOrderDescCmdImpl()
Method Detail

getOrderId

protected java.lang.Long getOrderId()

getReturnData

public byte[] getReturnData()
Returns the byte Array containing the detail description of the order suitable for display by a wallet application running on the shopper's machine.
Specified by:
getReturnData in interface GetOrderDescCmd
Returns:
byte[]

isReadyToCallExecute

public boolean isReadyToCallExecute()
This method is called by the Command Framework to check if all basic mandatory parameters have been set for this command. This is done before the Framework calls the performExecute method of the command.
Overrides:
isReadyToCallExecute in class AbstractECCommand
Following copied from class: com.ibm.commerce.command.AbstractECCommand
Returns:
boolean - true if we can execute the command false if we canot execute the command

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECCommand
Following copied from interface: com.ibm.commerce.command.ECCommand
Throws:
com.ibm.commerce.command.CommandException - The superclass for all ECExceptions.

reset

public void reset()
Resets the instance variables of the command. The reset() method will reset all instance variables. If the command includes any output values that are accessible via getters, then make sure those values are no longer needed before calling this method to reset the instance variables of the command.

This is useful if the command instance is to be called multiple times with different command parameters.

Overrides:
reset in class AbstractECCommand

setOrderId

public void setOrderId(java.lang.Long orderId)
Sets the orderId property of the command.
Specified by:
setOrderId in interface GetOrderDescCmd
Parameters:
orderId - the order reference number of the Order for which the detail order description is to be prepared.

setReturnData

protected void setReturnData(byte[] ba)