com.ibm.commerce.returns.commands
Class CalculateReturnItemCreditForCatEntryCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.returns.commands.CalculateReturnItemCreditForCatEntryCmdImpl
All Implemented Interfaces:
CalculateReturnItemCreditForCatEntryCmd, ECCommand, ECTargetableCommand, TaskCommand

public class CalculateReturnItemCreditForCatEntryCmdImpl
extends TaskCommandImpl
implements CalculateReturnItemCreditForCatEntryCmd

Default implementation of the CalculateReturnItemCreditForCatEntryCmd interface. Calculate the CREDITAMOUNT, the ADJUSTMENTCREDIT and any charges against a catalog entry return mechandise authorization (RMA) item. This applies to both RMA items which don't reference an order item and RMA items which are kit parts. This implementation calculates the following values:

Utilizes these access beans

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.returns.commands. CalculateReturnItemCreditForCatEntryCmd
COPYRIGHT, defaultCommandClassName, NAME
 
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
CalculateReturnItemCreditForCatEntryCmdImpl()
          CalculateReturnItemCreditForCatEntryCmdImpl constructor.
 
Method Summary
protected  java.lang.Long getCatEntryId()
          Returns catalog entry Id.
protected  java.lang.Double getQuantity()
          Get the quantity.
protected   RMAAccessBean getRMAAB()
          Get the RMA access bean..
protected   RMAItemAccessBean getRMAItemAB()
          Get the RMA item access bean.
 void performExecute()
          Execute the command.
 void reset()
          Reset the command.
 void setCatEntryId(java.lang.Long aCatEntryId)
          Set the catEntry Id.
 void setQuantity(java.lang.Double aQuantity)
          Set the quantity to be credited.
 void setRMAAB( RMAAccessBean newRMAAB)
          Set the RMA for which the refund is being requested.
 void setRMAItemAB( RMAItemAccessBean newRMAItemAB)
          Set the RMA Item access bean which will have its amounts updated.
 void validateParameters()
          Check mandatory parameters.
 
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand
accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalculateReturnItemCreditForCatEntryCmdImpl

public CalculateReturnItemCreditForCatEntryCmdImpl()
CalculateReturnItemCreditForCatEntryCmdImpl constructor.
Method Detail

getCatEntryId

protected java.lang.Long getCatEntryId()
Returns catalog entry Id.
Returns:
catalog entry ID

getQuantity

protected java.lang.Double getQuantity()
Get the quantity.
Returns:
The quantity being returned.

getRMAAB

protected RMAAccessBean getRMAAB()
Get the RMA access bean..
Returns:
The RMA access bean.

getRMAItemAB

protected RMAItemAccessBean getRMAItemAB()
Get the RMA item access bean.
Returns:
The RMA item access bean.

performExecute

public void performExecute()
                    throws ECException
Execute the command.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
ECException

reset

public void reset()
Reset the command.
Overrides:
reset in class AbstractECTargetableCommand

setCatEntryId

public void setCatEntryId(java.lang.Long aCatEntryId)
Set the catEntry Id.
Specified by:
setCatEntryId in interface CalculateReturnItemCreditForCatEntryCmd
Parameters:
aCatEntryId - The catalog entry Id.

setQuantity

public void setQuantity(java.lang.Double aQuantity)
Set the quantity to be credited.
Specified by:
setQuantity in interface CalculateReturnItemCreditForCatEntryCmd
Parameters:
aQuantity - The quantity to be credited.

setRMAAB

public void setRMAAB(RMAAccessBean newRMAAB)
Set the RMA for which the refund is being requested.
Specified by:
setRMAAB in interface CalculateReturnItemCreditForCatEntryCmd
Parameters:
newRMAAB - The RMA access bean.

setRMAItemAB

public void setRMAItemAB(RMAItemAccessBean newRMAItemAB)
Set the RMA Item access bean which will have its amounts updated.
Specified by:
setRMAItemAB in interface CalculateReturnItemCreditForCatEntryCmd
Parameters:
newRMAItemAB - Tha RMA item access bean.

validateParameters

public void validateParameters()
                        throws ECException
Check mandatory parameters. Checks the following parameters:

Parameters

Specified by:
validateParameters in interface ECCommand
Overrides:
validateParameters in class AbstractECTargetableCommand
Throws:
ECApplicationException - If there is no StoreAccessBean or there is no catalog entry id or there is no RMAItemAccessBean or there is no RMAccessBean or a quantity has not be specified , throws com.ibm.commerce.exception.ECApplicationException with ECMessage._ERR_BAD_MISSING_CMD_PARAMETER
ECException