com.ibm.commerce.edp.commands

Class EditVoidCmdImpl

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

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, AEDPPaymentTaskCmd, AEDPTaskCmd, EditCmd, 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 EditVoidCmdImpl
extends AEDPPaymentTaskCmdImpl
implements EditCmd

This task command should be called when payment instructions are modified. This applies to amount changes or payment protocol data changes. This void implementation will do nothing.

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

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
EditVoidCmdImpl()

Method Summary

Modifier and Type	Method and Description
AccountAccessBean	getAccount() This method returns the AccountAccessBean representing the business account if an account ID is present.
java.lang.Long	getAccountId() This method returns the business account ID if one is specified by the trading agreements used by the order items of the order being processed.
EDPEditResults	getEditResults() This method obtains the edit results.
OrderAccessBean	getOrderAccessBean() This method returns the order access bean associated with this command.
java.math.BigDecimal	getOrderAmount() This method returns the total order amount.
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() This method executes the business logic of this command implementation.Does nothing.
void	reset() This method resets the command fields.
void	setAccountId(java.lang.Long n) This method sets the business account ID.
void	setEditResults(EDPEditResults localEditResults) This method sets the edit results.
void	setForcedPaymentInstructionChangeFlag(boolean forcedChange) Void implementation
void	setOrderAmount(java.math.BigDecimal paramOrderAmount) This method sets the total order amount.
void	setPaymentInstructions(java.util.ArrayList pis) Void implementation
void	setPONumber(java.lang.String aPONumber) Void implementation
void	systemEditableAddOrderAmount(java.lang.Long edpOrderId, java.math.BigDecimal addToPIAmount) Void implementation

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

EditVoidCmdImpl

public EditVoidCmdImpl()

Method Detail

getAccount

public AccountAccessBean getAccount()

This method returns the AccountAccessBean representing the business account if an account ID is present. null otherwise.

This method will first check if the local variable iabAccount is set. If not set, it will attempt to retrieve the AccountAccessBean using the specified business account ID.

Returns:

The AccountAccessBean if it can be retrieved; null otherwise.

setAccountId

public void setAccountId(java.lang.Long n)

This method sets the business account ID.

This is the common account ID if one is specified by the trading agreements used by the order items of the order being processed. If there is no common account ID, this method should not be called at all.

Parameters:

n - A Long that specifies the Account ID.

getAccountId

public java.lang.Long getAccountId()

This method returns the business account ID if one is specified by the trading agreements used by the order items of the order being processed.

If there is no business account associated with any of the trading agreements, null is returned.

Returns:

A Long that specifies the account ID if present; null otherwise.

setEditResults

public final void setEditResults(EDPEditResults localEditResults)

This method sets the edit results.

Specified by:

setEditResults in interface EditCmd

Parameters:

localEditResults - An EDPEditResults that represents the edit results to be set

getEditResults

public final EDPEditResults getEditResults()

This method obtains the edit results.

Specified by:

getEditResults in interface EditCmd

Returns:

An EDPEditResults that represents the edit results.

getOrderAccessBean

public OrderAccessBean getOrderAccessBean()

This method returns the order access bean associated with this command.

It checks if the local variable is set. If not, it will attempt to get it by creating a new access bean.

Returns:

The OrderAccessBean that corresponds to the order associated with this request

setOrderAmount

public void setOrderAmount(java.math.BigDecimal paramOrderAmount)

This method sets the total order amount.

Specified by:

setOrderAmount in interface EditCmd

Parameters:

paramOrderAmount - A BigDecimal that specifies the total order amount.

getOrderAmount

public java.math.BigDecimal getOrderAmount()

This method returns the total order amount.

Returns:

A BigDecimal that specifies the total order amount; null may be returned.

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 is true if the command is ready to execute and false otherwise.

performExecute

public void performExecute()
                    throws ECException

This method executes the business logic of this command implementation.Does nothing.

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

setForcedPaymentInstructionChangeFlag

public void setForcedPaymentInstructionChangeFlag(boolean forcedChange)

Void implementation

Specified by:

setForcedPaymentInstructionChangeFlag in interface EditCmd

Parameters:

forcedChange - A boolean that indicates if the if the payment instruction edit operation is forced or not.

setPONumber

public void setPONumber(java.lang.String aPONumber)

Void implementation

Specified by:

setPONumber in interface EditCmd

Parameters:

aPONumber - A String specifies the purchase order number specified by the buyer.

setPaymentInstructions

public void setPaymentInstructions(java.util.ArrayList pis)

Void implementation

Specified by:

setPaymentInstructions in interface EditCmd

Parameters:

pis - An ArrayList that represents the pis.

systemEditableAddOrderAmount

public void systemEditableAddOrderAmount(java.lang.Long edpOrderId,
                                         java.math.BigDecimal addToPIAmount)
                                  throws EDPException,
                                         ECException

Void implementation

Specified by:

systemEditableAddOrderAmount in interface EditCmd

Parameters:

edpOrderId - A Long that specifies the edpOrderId.

addToPIAmount - A Long that specifies the amount that will be added to the pi.

Throws:

EDPException

ECException