com.ibm.commerce.edp.commands

Class PIEditVoidCmdImpl

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

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, AEDPCtrlCmd, PIEditCmd, 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 PIEditVoidCmdImpl
extends AEDPPIEditCtrlCmdImpl
implements PIEditCmd

This is the void implementation of the PIEditCmd controller command.

The void implementation of commands is used when anyone is intended to disable the command while keeping the single code base. Note that please use the void implementation of all commands once you decide to disable the command implementation.

See Also:

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

defaultCommandClassName, NAME, PAYMENT_INSTRUCTION_ERROR_VIEW

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
PIEditVoidCmdImpl() The default constructor.

Method Summary

Modifier and Type	Method and Description
boolean	getForcedPaymentInstructionChangeFlag() This method gets the forced flag that indicates if this request will be forced or not.
java.lang.Long	getPIID() This method gets the payment instruction ID.
boolean	isAmountEditable() This method returns the amount editable flag indicating if the amount is dirty or not.
boolean	isPaymentDataEditable() This method returns the payment data editable flag indicating if the payment data is dirty or not.
void	performExecute() This method removes the old payment instruction and add a new payment instruction with all new protocol data and/or amount/currency.
void	reset() This method resets the command fields.
void	setAmountEditable(boolean amountEditable) This method sets the amount editable flag indicating if the amount is dirty or not.
void	setForcedPaymentInstructionChangeFlag(boolean forcedChange) This method sets the forced flag indicating if the request will be forced or not.
void	setPaymentDataEditable(boolean paymentDataEditable) This method sets the payment data editable flag indicating if the payment data is dirty or not.
void	setPIId(java.lang.Long aPIId) This method sets the payment instruction ID.
void	setRequestProperties(TypedProperty reqProperties) This method sets the input parameters from the request, which does nothing here.
void	validateParameters() This method verifies that required input parameters are present and correct, which does nothing here.

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

getAmount, getPaymentMethodID, getPiIdNull, getPolicyId, getProtocolData, getResources, 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.PIEditCmd

setProtocolData, 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, getResources, 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

PIEditVoidCmdImpl

public PIEditVoidCmdImpl()

The default constructor.

Method Detail

setForcedPaymentInstructionChangeFlag

public void setForcedPaymentInstructionChangeFlag(boolean forcedChange)

This method sets the forced flag indicating if the 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:

setForcedPaymentInstructionChangeFlag in interface PIEditCmd

Parameters:

forcedChange - indicates if the request is forced or not

getForcedPaymentInstructionChangeFlag

public boolean getForcedPaymentInstructionChangeFlag()

This method gets the forced flag that indicates if this request will be forced or not.

Returns:

the forced flag

getPIID

public java.lang.Long getPIID()

This method gets the payment instruction ID.

Returns:

iPIID the payment instruction ID

setPIId

public void setPIId(java.lang.Long aPIId)

This method sets the payment instruction ID.

Specified by:

setPIId in interface PIEditCmd

Parameters:

aPIId - the payment instruction ID

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

This method sets the input parameters from the request, which does nothing here.

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 removes the old payment instruction and add a new payment instruction with all new protocol data and/or amount/currency.

Actually it does nothing here.

Specified by:

performExecute in interface ECCommand

Specified by:

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

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException - if something fails

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 that required input parameters are present and correct, which does nothing here.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException - if something input is invalid or missing

isAmountEditable

public boolean isAmountEditable()

This method returns the amount editable flag indicating if the amount is dirty or not.

Returns:

the flag indicating if the amount is editable

isPaymentDataEditable

public boolean isPaymentDataEditable()

This method returns the payment data editable flag indicating if the payment data is dirty or not.

Returns:

the payment data editable flag

setAmountEditable

public void setAmountEditable(boolean amountEditable)

This method sets the amount editable flag indicating if the amount is dirty or not. True by default.

Specified by:

setAmountEditable in interface PIEditCmd

Parameters:

amountEditable - indicates if the amount is dirty or not

setPaymentDataEditable

public void setPaymentDataEditable(boolean paymentDataEditable)

This method sets the payment data editable flag indicating if the payment data is dirty or not. True by default.

Specified by:

setPaymentDataEditable in interface PIEditCmd

Parameters:

paymentDataEditable - indicates if the payment data is dirty or not