com.ibm.commerce.returns.commands

Class ARefundTaskCmdImpl

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.returns.commands.ARefundTaskCmdImpl

All Implemented Interfaces:

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

FinalizeRefundCmdImpl, PrimeRefundCmdImpl, SynchronizeReturnWithBackendCmdImpl

public abstract class ARefundTaskCmdImpl
extends AEDPTaskCmdImpl
implements ARefundTaskCmd

This class is the abstract refund task command class. This class stores the common methods used by multiple specific refund requests.

See Also:

Serialized Form

Field Summary

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
ARefundTaskCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrency() This method returns the current currency.
java.lang.Integer	getCurrentStoreId() This method returns the store id through RMA.
java.lang.Long	getPaymentPolicyId() This method returns the payment policy ID and the corresponding policy will be used as the refund method.
java.util.ArrayList	getRefundInstructions() This method returns the refund instructions.
java.lang.Long	getRmaId() This method returns the identifier of current RMA.
boolean	isProcessBGExecutableInFG() This method checks if the background tasks can be processed in the foreground thread.
void	reset() This method resets the instance variable of this command.
void	setBgJobStatusInDb(java.lang.Integer bgJobStatus) This method sets the background status on the current refund.
void	setCurrency(java.lang.String localCurrency) This method sets the current currency.
void	setPaymentPolicyId(java.lang.Long localPaymentPolicyId) This method sets the payment policy ID and the corresponding policy will be used as the refund method, this value is set by ReturnProcessCmdImpl.
void	setRefundInstructions(java.util.ArrayList localRefundInstructions) This method sets the refund instructions.
void	setRMAAB(RMAAccessBean anRMAAB) This method sets the RMA being accessed.
void	setRmaId(java.lang.Long localRmaId) This method sets the identifier of current RMA(Return Merchandise Authorization).
java.lang.String	toString() This method converts this request data into a human-readable string.
void	validateInsideProcessFG() This method validates if the required parameters are present for the foreground tasks.

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, getStoreId, 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

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

Constructor Detail

ARefundTaskCmdImpl

public ARefundTaskCmdImpl()

Method Detail

setRmaId

public void setRmaId(java.lang.Long localRmaId)

This method sets the identifier of current RMA(Return Merchandise Authorization).

Specified by:

setRmaId in interface ARefundTaskCmd

Parameters:

localRmaId - The identifier of current RMA

getRmaId

public final java.lang.Long getRmaId()

This method returns the identifier of current RMA.

Returns:

The identifier of current RMA

setCurrency

public void setCurrency(java.lang.String localCurrency)

This method sets the current currency.

Parameters:

localCurrency - The currency to set

getCurrency

public java.lang.String getCurrency()

This method returns the current currency.

Specified by:

getCurrency in interface AEDPTaskCmd

Overrides:

getCurrency in class AEDPTaskCmdImpl

Returns:

The current currency

getRefundInstructions

public java.util.ArrayList getRefundInstructions()

This method returns the refund instructions.

Returns:

The refund instructions

setRefundInstructions

public void setRefundInstructions(java.util.ArrayList localRefundInstructions)

This method sets the refund instructions.

Parameters:

localRefundInstructions - ArrayList The current refund instructions to process

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 if the required parameters are present for the foreground tasks. In this implementation, it will call AEDPTaskCmdImpl.validateInsideProcessFG(), then check if RMA ID is present.

Overrides:

validateInsideProcessFG in class AEDPTaskCmdImpl

Throws:

EDPException - In case Payment Rules error

isProcessBGExecutableInFG

public boolean isProcessBGExecutableInFG()

This method checks if the background tasks can be processed in the foreground thread.

Overrides:

isProcessBGExecutableInFG in class AEDPTaskCmdImpl

Returns:

If the background tasks can be processed in the foreground thread

setBgJobStatusInDb

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

This method sets the background status on the current refund.

Parameters:

bgJobStatus - The new status

Throws:

J2EEException - If EJBs cannot be accessed

InputException - If an invalid status or invalid order is selected

ECException - If store cannot be retrieved

getCurrentStoreId

public java.lang.Integer getCurrentStoreId()
                                    throws ECException

This method returns the store id through RMA. Because in Hub store, the store id in the command context is the id of Hub store. While the expected behavior is that it should be the owning store id, so this method gets the store id from the RMA.

Returns:

storeId The store ID in RMA

Throws:

ECException - If store id cannot be retrieved from the RMA

setRMAAB

public void setRMAAB(RMAAccessBean anRMAAB)

This method sets the RMA being accessed.

Parameters:

anRMAAB - The RMA access bean

reset

public void reset()

This method resets the instance variable of this command.

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AEDPTaskCmdImpl

getPaymentPolicyId

public java.lang.Long getPaymentPolicyId()

This method returns the payment policy ID and the corresponding policy will be used as the refund method.

Returns:

The payment policy ID and the corresponding policy will be used as the refund method

setPaymentPolicyId

public void setPaymentPolicyId(java.lang.Long localPaymentPolicyId)

This method sets the payment policy ID and the corresponding policy will be used as the refund method, this value is set by ReturnProcessCmdImpl.

Parameters:

localPaymentPolicyId - The payment policy ID to set.