ReturnItemDeleteCmdImpl

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.ControllerCommandImpl
        
        com.ibm.commerce.returns.commands.ReturnBaseCmdImpl
        
        com.ibm.commerce.returns.commands.ReturnItemDeleteCmdImpl

All Implemented Interfaces:: AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ReturnItemDeleteCmd, Protectable, 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 ReturnItemDeleteCmdImpl
extends ReturnBaseCmdImpl
implements ReturnItemDeleteCmd

This is the default implementation of the controller command ReturnItemDeleteCmd interface. It deletes a return merchandise authorization (RMA) item.

Input parameters:

Name	Description
`RMAItemId(required)`	RMA item ID (this can be specified multiple times).
`outRMAName(optional)`	the name to use for the name-value pair which will be passed to the redirected URL.
`URL (required)`	the URL to be called when the command completes successfully.
`forUserId (optional)`	it is specified when it is called by a CSR.

Behaviour:

Check to see if RMA exists. If not, return an error.
If RMA item has receipts or credits, then don't delete the RMA item and throw com.ibm.commerce.exception.ECApplicationException with ECMessage.ECMessage._ERR_CANNOT_DELETE_RETURN_ITEM.
Delete the RMA item.

It utilizes these access beans:

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl
  LOCAL
- Fields inherited from interface com.ibm.commerce.returns.commands.ReturnItemDeleteCmd
  defaultCommandClassName, NAME
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Constructor Summary

Constructors
Constructor and Description

ReturnItemDeleteCmdImpl()
This is the ReturnItemDeleteCmdImpl constructor.

Constructors
Constructor and Description
`ReturnItemDeleteCmdImpl()` This is the ReturnItemDeleteCmdImpl constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessVector`	`getResources()` This method gets the vector of resources accessed by this command.
`void`	`performExecute()` This method executes the main logic of the command.
`void`	`reset()` This method resets the command.
`void`	`setRequestProperties(TypedProperty aRequestProperties)` This method sets the request properties of this command implementation.
`void`	`validateParameters()` This method checks the mandatory parameters.

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

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.AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- Constructor Detail
  - ReturnItemDeleteCmdImpl
```
public ReturnItemDeleteCmdImpl()
```
    This is the ReturnItemDeleteCmdImpl constructor.
- Method Detail
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    This method gets the vector of resources accessed by this command.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    The vector of resource action pairs - RMA access bean list.
    
    Throws:
    
    ECException.
    
    ECException
  - performExecute
```
public void performExecute()
                    throws ECException
```
    This method executes the main logic of the command.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AbstractECTargetableCommand
    
    Throws:
    
    ECApplicationException - If the RMA item has credits or receipts against it, throws com.ibm.commerce.exception.ECApplicationException with ECMessage.ECMessage._ERR_CANNOT_DELETE_RETURN_ITEM
    
    ECException
  - reset
```
public void reset()
```
    This method resets the command.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AbstractECTargetableCommand
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
```
    This method sets the request properties of this command implementation.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class ControllerCommandImpl
    
    Parameters:
    
    aRequestProperties - the request properties.
    
    Throws:
    
    ECApplicationException.
    
    ECApplicationException
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    This method checks the mandatory parameters. It checks the following parameters:
    Parameters
    - storeid
      the store id
    - iRMAitemId
      array of RMA item IDs
    - URL
      the URL to be called when the command completes successfully.
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AbstractECTargetableCommand
    
    Throws:
    
    ECApplicationException - If there is no store id specified or there is no RMA item array or there is no RMA item id is invalid, throws com.ibm.commerce.exception.ECApplicationException with ECMessage._ERR_BAD_MISSING_CMD_PARAMETER
    
    InvalidParameterValueException - If there is no URL to be called on completion of the command, throws com.ibm.commerce.exception.InvalidParameterValueException with ECMessage._ERR_BAD_MISSING_CMD_PARAMETER
    
    ECException

Class ReturnItemDeleteCmdImpl

Input parameters:

Behaviour:

It utilizes these access beans:

Field Summary

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

Fields inherited from interface com.ibm.commerce.returns.commands.ReturnItemDeleteCmd

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

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

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

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

Methods inherited from interface com.ibm.commerce.command.AccCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

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

Methods inherited from interface com.ibm.commerce.security.Protectable

Constructor Detail

ReturnItemDeleteCmdImpl

Method Detail

getResources

performExecute

reset

setRequestProperties

validateParameters