com.ibm.commerce.edp.commands

Class ReservePaymentVoidCmdImpl

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

All Implemented Interfaces:

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

This is the void implementation of the ReservePaymentCmd task command.

Behaviour:

• This task command is called by com.ibm.commerce.inventory.commands.ReleaseOrdersToFulfillmentCmdImpl. 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.ReservePaymentCmd

defaultCommandClassName, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ReservePaymentVoidCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getReleaseIds() This method obtains the list of release ids to be reserved.
java.util.HashMap	getReleases() This method gets the list of releases to be processed in this request.
java.math.BigDecimal	getReservationAmount() This method gets the total amount to be reserved.
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 , which does nothing here.
void	reset() This method resets the command fields.
void	setReleases(java.util.HashMap paramReleases) This method sets the releases to be reserved.
void	setReservationAmount(java.math.BigDecimal paramReservationAmount) This method sets the total order amount.

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

ReservePaymentVoidCmdImpl

public ReservePaymentVoidCmdImpl()

Method Detail

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. Here this method does nothing.

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.

setReleases

public void setReleases(java.util.HashMap paramReleases)

This method sets the releases to be reserved.

Specified by:

setReleases in interface ReservePaymentCmd

Parameters:

paramReleases - A HashMap that represents the list of release IDs and their amounts to be reserved.

getReleases

public java.util.HashMap getReleases()

This method gets the list of releases to be processed in this request.

Returns:

A HashMap that represents the list of releases to be processed in this request.

setReservationAmount

public void setReservationAmount(java.math.BigDecimal paramReservationAmount)

This method sets the total order amount.

Specified by:

setReservationAmount in interface ReservePaymentCmd

Parameters:

paramReservationAmount - A BigDecimal that specifies the total amount to be reserved.

getReservationAmount

public java.math.BigDecimal getReservationAmount()

This method gets the total amount to be reserved.

Returns:

A BigDecimal that specifies the total amount to be reserved.

performExecute

public void performExecute()
                    throws ECException

This method executes the business logic of this command implementation , which 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 - This exception is thrown in case of a failure.

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

getReleaseIds

public java.util.Collection getReleaseIds()

This method obtains the list of release ids to be reserved.

Returns:

A Collection that represents the list of release ids to be reserved.