com.ibm.commerce.payment.commands
Interface PayResetPMCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
PayResetPMCmdImpl

public interface PayResetPMCmd
extends ECCommand, ControllerCommand

The PayResetPMCmd Controller Command resets the payment for an order that has been submitted to the Payment Manager for processing. Only order that has failed the submission could have its payment reset via this command.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String ERR_CODE_BAD_SYS
          Error code indicating a system error has occurred.
static java.lang.String ERR_CODE_CANCEL_ORDER_NOT_ALLOWED
          Error code indicating cancel/reset is not allowed.
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 setUrl(java.lang.String url)
          Sets the URL 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
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

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

ERR_CODE_BAD_SYS

public static final java.lang.String ERR_CODE_BAD_SYS
Error code indicating a system error has occurred. The constant value of this field is "1007".

ERR_CODE_CANCEL_ORDER_NOT_ALLOWED

public static final java.lang.String ERR_CODE_CANCEL_ORDER_NOT_ALLOWED
Error code indicating cancel/reset is not allowed. The constant value of this field is "1902".

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 "PayResetErrorView".

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 payment information is to be reset.

setUrl

public void setUrl(java.lang.String url)
Sets the URL property of the command.
Parameters:
url - the URL to redirect to after the command completes its processing.