com.ibm.commerce.edp.commands

Class AEDPPaymentTaskCmdImpl

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AEDPStoreTaskCmdImpl, CancelOrderCmdImpl, CancelOrderVoidCmdImpl, ChangePaymentCurrencyTaskCmdImpl, ChangePaymentCurrencyVoidTaskCmdImpl, CheckOrderEditableTaskCmdImpl, CheckOrderEditableVoidTaskCmdImpl, CheckOrderPaymentAuthorizedCmdImpl, CheckOrderPaymentAuthorizedVoidCmdImpl, CheckOrderPaymentDepositedCmdImpl, CheckOrderPaymentDepositedVoidCmdImpl, EditCmdImpl, EditVoidCmdImpl, ProcessPaymentEventCmdImpl, ProcessPaymentEventVoidCmdImpl, QueryPIsCmdImpl, QueryPIsVoidCmdImpl, SynchronizeOrderWithBackendCmdImpl, TriggerPaymentActionsCmdImpl, TriggerPaymentActionsVoidCmdImpl

public abstract class AEDPPaymentTaskCmdImpl
extends AEDPTaskCmdImpl
implements AEDPPaymentTaskCmd

This class is the base and abstract class for payment related task commands.

See Also:

Serialized Form

Field Summary

Fields

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

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

LOCAL

Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

defaultCommandClassName

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
AEDPPaymentTaskCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.util.Map	getErrorMessageMap() This method returns the map containing error message of each Payment Instruction.
java.lang.Integer	getStoreId() This method gets the current store id.
void	insertActionListToActionDetailHash(java.lang.Long piId, java.util.List actions) This method inserts actions list to the HashMap ,piId is key
void	insertActionListToEditActionDetailHash(java.lang.Long piId, java.util.List actions) This method inserts actions list to edit actions HashMap.
boolean	isBgJobInWorking() This method gets the current pending status of the order.
boolean	isProcessBGExecutableInFG() This method judges if the backend job could be executable in foreground.
void	reset() This method resets the command fields.
void	setBgJobStatusInDb(java.lang.Integer bgJobStatus) This method sets the background job status on the current order.
void	setErrorMessageMap(java.util.Map localErrorMessageMap) This method sets the map containing error message of each Payment Instruction.
void	setStoreId(java.lang.Integer integer) This method sets the current store id.
java.lang.String	toString() This method converts this request data into a human-readable string.
void	validateInsideProcessFG() This method validates the required information inside the ProcessFG() method of each payment task commands.

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, isReadyToCallExecute, performExecute, 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, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

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

isReadyToCallExecute

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, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

AEDPPaymentTaskCmdImpl

public AEDPPaymentTaskCmdImpl()

Method Detail

isBgJobInWorking

public boolean isBgJobInWorking()
                         throws InternalException,
                                J2EEException,
                                InputException

This method gets the current pending status of the order. This actually checks the background job status of the EDPOrder object.

Returns:

This method returns true if the order is in pending status, and otherwise returns false.

Throws:

InternalException - This exception is thrown if an internal logic error is detected.

J2EEException - This exception is thrown if EJBs cannot be accessed.

InputException - This exception is thrown if an invalid order id / store id combination is provided in the request.

setBgJobStatusInDb

public void setBgJobStatusInDb(java.lang.Integer bgJobStatus)
                        throws J2EEException,
                               InputException

This method sets the background job status on the current order.

Parameters:

bgJobStatus - the new status

Throws:

J2EEException - if EJBs cannot be accessed

InputException - if an invalid status or invalid order is selected

toString

public java.lang.String toString()

This method converts this request data into a human-readable string.

Overrides:

toString in class AEDPTaskCmdImpl

Returns:

a human-readable string representing the data of this request

validateInsideProcessFG

public void validateInsideProcessFG()
                             throws EDPException

This method validates the required information inside the ProcessFG() method of each payment task commands.

Overrides:

validateInsideProcessFG in class AEDPTaskCmdImpl

Throws:

EDPException - If error occurs

getErrorMessageMap

public java.util.Map getErrorMessageMap()

This method returns the map containing error message of each Payment Instruction. The map has the same structure as the returned map of getMessageOfFailedPayments(CommonBaseEvent).

Returns:

the map containing error message of each Payment Instruction

See Also:

getMessageOfFailedPayments(CommonBaseEvent)

setErrorMessageMap

public void setErrorMessageMap(java.util.Map localErrorMessageMap)

This method sets the map containing error message of each Payment Instruction.

Parameters:

localErrorMessageMap - the map containing error message of each Payment Instruction

isProcessBGExecutableInFG

public boolean isProcessBGExecutableInFG()

This method judges if the backend job could be executable in foreground.

Overrides:

isProcessBGExecutableInFG in class AEDPTaskCmdImpl

Returns:

This method returns a boolean that represents if the backend job could be executable in foreground. It returns true if the backend job could be executable in foreground and false otherwise.

insertActionListToActionDetailHash

public void insertActionListToActionDetailHash(java.lang.Long piId,
                                               java.util.List actions)

This method inserts actions list to the HashMap ,piId is key

Parameters:

piId - A Long that specifies the current payment instruction id.

actions - A List that specifies the current actions for this payment instruction.

insertActionListToEditActionDetailHash

public void insertActionListToEditActionDetailHash(java.lang.Long piId,
                                                   java.util.List actions)

This method inserts actions list to edit actions HashMap. The piId is key.

Parameters:

piId - A Long that specifies the current payment instruction id.

actions - A List that specifies the current list of actions for this payment instruction

getStoreId

public java.lang.Integer getStoreId()

This method gets the current store id.

Specified by:

getStoreId in interface ECCommand

Overrides:

getStoreId in class AbstractECTargetableCommand

Returns:

This method returns an Integer that represents the current store id.

setStoreId

public void setStoreId(java.lang.Integer integer)

This method sets the current store id.

Parameters:

integer - An Integer that specifies the current store id.

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 AEDPTaskCmdImpl