java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.payment.commands.DoCancelCmdImpl
Default
DoCancel
task command implementation is called by the
AdminOrderCancel Controller command to cancel the payment for an order.
Parameters:
Parameter Name | Type | Descriptions |
orderId | Order ID | ID of the order whose payment is to be canceled |
sPurge | String | Flag to indicate cleanup of the ORDPAYMTHD record is required. |
Behavior:
DoCancelPolicy
command for the Payment Policy used for the
Purchase. (The ID of the Payment Policy is stored in the ORDPAYMTHD
Table).PaymentConstants.ORDER_PURGE
(1) perform
the following:
Error View Name:
ErrorCodes:
This command uses the following AccessBeans:
This command calls the following BusinessPolicyCommands:
Field Summary |
---|
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.payment.commands. DoCancelCmd |
COPYRIGHT,
defaultCommandClassName,
ERRTASK_NAME,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
DoCancelCmdImpl() |
Method Summary | |
---|---|
protected
OrderAccessBean |
getOrder() Returns the OrderAccessBean representing the order whose payment is to be canceled. |
protected
java.lang.Long |
getOrderId() Returns the orderId property of the command. |
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. |
void |
setPurge(java.lang.String sPurge) Sets the purge property of the command. |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Constructor Detail |
---|
public DoCancelCmdImpl()
Method Detail |
---|
protected OrderAccessBean getOrder()
This method first checks if the local variable is set or not. If not set, it will attempt to get it by creating a new AccessBean.
protected java.lang.Long getOrderId()
public boolean isReadyToCallExecute()
isReadyToCallExecute
in class
AbstractECTargetableCommand
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
public void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
public void setOrderId(java.lang.Long orderId)
setOrderId
in interface
DoCancelCmd
orderId
- the ID of the Order whose payment is to be
canceledpublic void setPurge(java.lang.String sPurge)
setPurge
in interface
DoCancelCmd