com.ibm.commerce.edp.commands

Class PIRemoveCmdImpl

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.ControllerCommandImpl

com.ibm.commerce.order.commands.OrderBaseCmdImpl

com.ibm.commerce.edp.commands.AEDPCtrlCmdImpl

com.ibm.commerce.edp.commands.AEDPPIEditCtrlCmdImpl

com.ibm.commerce.edp.commands.PIRemoveCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AEDPCtrlCmd, PIRemoveCmd, Protectable, 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 PIRemoveCmdImpl
extends AEDPPIEditCtrlCmdImpl
implements PIRemoveCmd

This is the default implementation of the PIRemoveCmdcontroller command.

Input parameters:

Name	XPath	Description
orderId	/XML/orderId	The identifier of the order for which the payment method is to be changed. Mandatory.
URL	/XML/URL	The URL to be called when the command completes successfully. Mandatory.
piId	/XML/piId	The numeric identifier (big integer) of the payment instruction to remove. The piId can be obtained from the EDPPaymentInstructionsDataBean data bean and represents the combination of the payment method, payment amount, and any protocol data. This parameter can be repeated if there are more payment instructions to be removed in this request.
errorViewName	/XML/errorViewName	The view name which is redirected to when the execution fails. If this parameter is provided, the default error view name is PaymentInstructionErrorView.

Output parameters:

None.

Behaviour:

• Validates that the orderId, at least one piId, and a URL are passed as parameters.
• Validates that an order exists for the orderId.
• Creates an EDPPaymentInstruction for each PI to be removed with the ID to cancel attribute settings, and adds it to a list of PIs to delete.
• Calls the EditCmd task command with the orderId, the list of PIs to delete, and the total order amount.
• Checks the results from the task command and redirects to an error view. Otherwise, it redirects to the URL that was passed as a parameter.

Task commands called:

See Also:

EditCmd, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM Copyright notice field.

Fields inherited from class com.ibm.commerce.edp.commands.AEDPPIEditCtrlCmdImpl

BILLING_ADDRESS_ID_PROPERTY_NAME, EDP_EDIT_FORCEFLAG, POLICY_ID, PURCHASEORDER_ID_PROPERTY_NAME

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

LOCAL

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

defaultCommandClassName, NAME, PAYMENT_INSTRUCTION_ERROR_VIEW

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
PIRemoveCmdImpl() The default Constructor.

Method Summary

Modifier and Type	Method and Description
AccessVector	getResources() This method returns the vector of resources accessed by this command, which uses the order access bean for resource access control.
void	performExecute() This method contains the actual business logic of the command.
void	reset() This method resets the command fields.
void	setPIIDs(java.lang.Long[] aPIIDs) This method sets the list of IDs of payment instructions to be canceled.
void	setRequestProperties(TypedProperty reqProperties) This method sets the input parameters from the request.
void	validateParameters() This method verifies input parameters.

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

getAmount, getPaymentMethodID, getPiIdNull, getPolicyId, getProtocolData, getURL, setAmount, setPaymentMethodID, setPolicyId, setProtocolData, setURL

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

getLocale, getOrderId, getStoreId, setOrderId

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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

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

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, toString, wait, wait, wait

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

setURL

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

getLocale, getOrderId, setOrderId

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

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.AccCommand

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

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

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

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

isReadyToCallExecute

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

PIRemoveCmdImpl

public PIRemoveCmdImpl()

The default Constructor.

Method Detail

setPIIDs

public void setPIIDs(java.lang.Long[] aPIIDs)

This method sets the list of IDs of payment instructions to be canceled.

Specified by:

setPIIDs in interface PIRemoveCmd

Parameters:

aPIIDs - the list of payment instruction IDs to be canceled.

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

This method sets the input parameters from the request.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqProperties - the input parameters from the request

Throws:

ECException - if something fails

performExecute

public void performExecute()
                    throws ECException

This method contains the actual business logic of the command.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - for error conditions

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 AEDPPIEditCtrlCmdImpl

validateParameters

public void validateParameters()
                        throws ECException

This method verifies input parameters.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - if some required parameters are missing or invalid

getResources

public AccessVector getResources()
                          throws ECException

This method returns the vector of resources accessed by this command, which uses the order access bean for resource access control.

Specified by:

getResources in interface ECCommand

Overrides:

getResources in class AEDPPIEditCtrlCmdImpl

Returns:

a vector of resource action pairs

Throws:

ECException - in the case of a failure