com.ibm.commerce.edp.commands

Class CancelOrderCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.edp.commands.AEDPTaskCmdImpl

com.ibm.commerce.edp.commands.AEDPPaymentTaskCmdImpl

com.ibm.commerce.edp.commands.CancelOrderCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, AEDPPaymentTaskCmd, AEDPTaskCmd, CancelOrderCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class CancelOrderCmdImpl
extends AEDPPaymentTaskCmdImpl
implements CancelOrderCmd

This is the default implementation of the CancelOrderCmd task command.

Behaviour:

• It reverses all approved atomic payments,cancels the active payment instructions of the current EDP order, and cancels this EDP order.

Input parameters:

commandContext	The command context.
orderId	A Long that specifies the order id.
forceFlag	A Boolean that indicates if the request will be forced or no.

Output parameters:

None.

Task commands called:

• EditPaymentInstructionPolicyCmd
• EvaluatePaymentRulesCmd

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.edp.commands.CancelOrderCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
CancelOrderCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getForcedCancel() This method returns the forced flag that shows if this request will be forced or not.
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() Executes the business logic of this command implementation.
void	processBG() This method actually executes the approve reversal action, and cancels the active payment instructions of current EDP order.
void	processFG() This method is the main method to process the current cancel order request.
void	reset() This method resets the command fields.
void	setForcedCancel(java.lang.Boolean paramFlag) This method sets the forced flag that shows if the cancel request will be forced or not.

Methods inherited from class com.ibm.commerce.edp.commands.AEDPPaymentTaskCmdImpl

getErrorMessageMap, getStoreId, insertActionListToActionDetailHash, insertActionListToEditActionDetailHash, isBgJobInWorking, isProcessBGExecutableInFG, setBgJobStatusInDb, setErrorMessageMap, setStoreId, toString, validateInsideProcessFG

Methods inherited from class com.ibm.commerce.edp.commands.AEDPTaskCmdImpl

getCurrency, getEdpException, getEDPOrderId, getEDPResults, getLanguageId, getLocale, getOrderChannel, getOrderId, getStatus, isIdempotent, isProcessBGTasksRequired, resetServices, setBGProcessFinished, setEdpException, setEDPOrderId, setEDPResults, setOrderChannel, setOrderId, setProcessBGTasksRequired, setStatus

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.commerce.edp.commands.AEDPTaskCmd

getCurrency, getEDPResults, getLanguageId, getLocale, getOrderChannel, getOrderId, setEDPResults, setOrderId

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Constructor Detail

CancelOrderCmdImpl

public CancelOrderCmdImpl()

Method Detail

setForcedCancel

public void setForcedCancel(java.lang.Boolean paramFlag)

This method sets the forced flag that shows if the cancel request will be forced or not. It is up to the caller to set the forceFlag whether they want to do the a forced request or not.

Specified by:

setForcedCancel in interface CancelOrderCmd

Parameters:

paramFlag - A Boolean that indicates if the request is forced or not.

getForcedCancel

public java.lang.Boolean getForcedCancel()

This method returns the forced flag that shows if this request will be forced or not.

Returns:

A Boolean that specifies if the request is forced or not.

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.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

A boolean that represents if the command is ready to execute.

performExecute

public void performExecute()
                    throws ECException

Executes the business logic of this command implementation.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

This method resets the command fields. After this method is invoked, and proper attributes are set, the command can be executed again.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AEDPPaymentTaskCmdImpl

processBG

public void processBG()
               throws EDPException,
                      ECException

This method actually executes the approve reversal action, and cancels the active payment instructions of current EDP order. Then it cancels current EDP order.

Throws:

EDPException

ECException

processFG

public void processFG()
               throws ECException,
                      EDPException

This method is the main method to process the current cancel order request. It firstly checks if current EDP order has been canceled, if it is, directly return. It then checks all atomic payments of current EDP order. And put all those approved atomic payments to the reverse approval list to be reverse approved later. If the reverse approval list is empty and there are no active payment instructions for current EDP order, then cancel this EDP order.

Throws:

ECException

EDPException