com.ibm.commerce.payment.commands
Interface DoCancelCmd

All Superinterfaces:
ECCommand, TaskCommand
All Known Implementing Classes:
DoCancelCmdImpl

public interface DoCancelCmd
extends TaskCommand

The DoCancelCmd Task Command is called by the AdminOrderCancel Controller command to cancel the payment for an order.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String ERRTASK_NAME
          Name of the Error View for this command.
static java.lang.String NAME
           
 
Method Summary
 void setOrderId(java.lang.Long orderId)
          Sets the orderId property of the command.
 void setPurge(java.lang.String sPurge)
          Sets the purge property of the command.
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.

ERRTASK_NAME

public static final java.lang.String ERRTASK_NAME
Name of the Error View for this command. The constant value of this field is "DoCancelErrorView".

NAME

public static final java.lang.String NAME
Method Detail

setOrderId

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

setPurge

public void setPurge(java.lang.String sPurge)
Sets the purge property of the command.
Parameters:
purge - - with this set to "1" will remove row in ordpaymthd of the cancelling order