com.ibm.commerce.payment.commands
Class DoCancelCLCmdImpl

java.lang.Object
  CacheableCommandImpl
      com.ibm.commerce.command.AbstractECTargetableCommand
          com.ibm.commerce.command.TaskCommandImpl
              com.ibm.commerce.command.BusinessPolicyCommandImpl
                  com.ibm.commerce.payment.commands.DoCancelCLCmdImpl
All Implemented Interfaces:
BusinessPolicyCommand, DoCancelPolicyCmd, ECCommand, ECTargetableCommand, TaskCommand

public class DoCancelCLCmdImpl
extends BusinessPolicyCommandImpl
implements DoCancelPolicyCmd

This DoCancelPolicy business policy command implementation class is the default implementation class for cancelling payment for CreditLine.

Parameters:

Parameter Name Type Descriptions
abOrder OrderAccessBean The Order Access Bean
errorViewName String Optional error view name passed in by the Caller.

Behavior:

Default Error View Name:

ErrorCodes:

This command uses the following AccessBeans:

This command does not call other TaskCommand.

See Also:
Serialized Form

Field Summary
Fields inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
policyId, requestProperties
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
commandContext
Fields inherited from interface com.ibm.commerce.payment.commands.DoCancelPolicyCmd
defaultCommandClassName, ERRTASK_NAME, NAME
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
Constructor Summary
DoCancelCLCmdImpl()
Method Summary
protected java.lang.String getErrorViewName()
Returns the name of the error view to use for reporting error.
protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the order whose payment is to be canceled.
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 setErrorViewName(java.lang.String sEVN)
Sets the error view to be used to report error.
void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Methods inherited from class com.ibm.commerce.command.BusinessPolicyCommandImpl
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties
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, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, 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.BusinessPolicyCommand
getPolicyId, getRequestProperties, setPolicyId, setRequestProperties

Constructor Detail

DoCancelCLCmdImpl

public DoCancelCLCmdImpl()
Method Detail

getErrorViewName

protected java.lang.String getErrorViewName()
Returns the name of the error view to use for reporting error.
Returns:
the error view name

getOrder

protected OrderAccessBean getOrder()
Returns the OrderAccessBean representing the order whose payment is to be canceled.
Returns:
the OrderAccessBean

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 AbstractECTargetableCommand
Returns:
true if we can execute the command; false otherwise.

performExecute

public void performExecute()
                    throws ECException
Performs the main business logic of the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException

setErrorViewName

public void setErrorViewName(java.lang.String sEVN)
Sets the error view to be used to report error. This overrides the default error view of the command.
Specified by:
setErrorViewName in interface DoCancelPolicyCmd
Parameters:
sEVN - the Error View name
See Also:
DoCancelPolicyCmd.ERRTASK_NAME

setOrder

public void setOrder(OrderAccessBean ab)
Sets the order property of the command.
Specified by:
setOrder in interface DoCancelPolicyCmd
Parameters:
ab - the OrderAccessBean representing the Order whose payment is to be canceled.

Feedback