com.ibm.commerce.edp.commands

Class FinalizePaymentVoidCmdImpl

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

com.ibm.commerce.edp.commands.FinalizePaymentVoidCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, AEDPPaymentTaskCmd, AEDPStoreTaskCmd, AEDPTaskCmd, FinalizePaymentCmd, 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 FinalizePaymentVoidCmdImpl
extends AEDPStoreTaskCmdImpl
implements FinalizePaymentCmd

This is the void implementation of the FinalizePaymentCmd task command.

Behaviour:

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

Input parameters:

None.

Output parameters:

None.

Task commands called:

None.

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.websphere.command.TargetableCommandImpl

LOCAL

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

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
FinalizePaymentVoidCmdImpl()

Method Summary

Modifier and Type	Method and Description
void	executeFinalizePaymentTCs() This method executes the paymentTCs required to call EDP finalizePayment
java.math.BigDecimal	getFinalizationAmount() This method returns the amount to be finalized as a BigDecimal Object.
OrderAccessBean	getOrderAccessBean() This method returns a reference to the order access bean.
java.lang.Long	getReleaseId() This method returns the current release id.
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.Just do nothing.
void	reset() This method resets the command fields.
void	setFinalizationAmount(java.math.BigDecimal paramFinalizationAmount) This method sets the amount to be finalized.
void	setReleaseId(java.lang.Long paramReleaseId) This method sets the ID of the release for which the amount is being finalized.

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

getCurrency, getOrderAmount, getPaymentInstructions, setCurrency, setOrderAmount, setPaymentInstructions, validateInsideProcessFG

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

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

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

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM Copyright notice field.

See Also:

Constant Field Values

Constructor Detail

FinalizePaymentVoidCmdImpl

public FinalizePaymentVoidCmdImpl()

Method Detail

setFinalizationAmount

public void setFinalizationAmount(java.math.BigDecimal paramFinalizationAmount)

This method sets the amount to be finalized.

Specified by:

setFinalizationAmount in interface FinalizePaymentCmd

Parameters:

paramFinalizationAmount - A BigDecimal that specifies the amount to be finalized.

getFinalizationAmount

public java.math.BigDecimal getFinalizationAmount()

This method returns the amount to be finalized as a BigDecimal Object.

Returns:

A BigDecimal that specifies the amount to be finalized.

getOrderAccessBean

public OrderAccessBean getOrderAccessBean()

This method returns a reference to the order access bean.

This method will first check if there is a local reference to the order access bean. If not present, it will create a new one.

Returns:

A OrderAccessBean that corresponds to the Order to paid for.

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.

setReleaseId

public void setReleaseId(java.lang.Long paramReleaseId)

This method sets the ID of the release for which the amount is being finalized.

Specified by:

setReleaseId in interface FinalizePaymentCmd

Parameters:

paramReleaseId - A Long that specifies the sets the ID of the release.

getReleaseId

public java.lang.Long getReleaseId()

This method returns the current release id.

Returns:

A Long that specifies the ID of the release for which the amount is being finalized.

executeFinalizePaymentTCs

public void executeFinalizePaymentTCs()
                               throws ECException

This method executes the paymentTCs required to call EDP finalizePayment

Throws:

ECException

performExecute

public void performExecute()
                    throws ECException

This method executes the business logic of this command implementation.Just do 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