com.ibm.commerce.ordermanagement.commands

Class ReturnEditBeginCmdImpl

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.ordermanagement.commands.ReturnEditBaseCmdImpl

com.ibm.commerce.ordermanagement.commands.ReturnEditBeginCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ReturnEditBeginCmd, 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 ReturnEditBeginCmdImpl
extends ReturnEditBaseCmdImpl
implements ReturnEditBeginCmd

This class is the default implementation of the ReturnEditBeginCmd controller controller command interface.

Input parameters:

Name	Description
iTakeOverLock	Takes over the lock or not. It should be "Y" or "N", default is "N".

Behaviour:

To invoke this command, a valid RMA ID has to be passed in from command context. An exception is thrown if an invalid RMA is passed.

If the RMA is not locked by others, lock it. Otherwise, if the iTakeOverLock flag set to "Y", unlock the RMA which is locked by others, and lock it. An ECException will be thrown if it can't be locked by current user.

After the command is invoked, the RMA is in an editable state. RMAs that are in edit(EDT), pending(PND) and approved(APP) state can be edited.

If the command is successful, the status of the RMA will be set to EDT and the RMA "INUSE" flag will be set to "Y". The RMA will not be processed by the system until the RMA gets submitted again.

If unsuccessful, the command throws the ECException.

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.ordermanagement.commands.ReturnEditBeginCmd

defaultCommandClassName, EC_RMA_ID, NAME

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

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
ReturnEditBeginCmdImpl()

Method Summary

Modifier and Type	Method and Description
void	performExecute() This method is the main logic for setting up the RMA for edits.
void	setRequestProperties(TypedProperty reqProperties) Sets the request properties of this command implementation.
void	setTakeOverLock(java.lang.String takeOverLock) This method sets if take over lock from others.
void	validateParameters() Extracts and validates the input parameters of this command implementation if validated, locks the RMA.

Methods inherited from class com.ibm.commerce.ordermanagement.commands.ReturnEditBaseCmdImpl

getResources, getRMA, getRMAId, isGeneric, isRetriable, reset, setRMA, setRMAId, toString

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

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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.ordermanagement.commands.ReturnEditBeginCmd

setRMA, setRMAId

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

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

isReadyToCallExecute, reset

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

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

ReturnEditBeginCmdImpl

public ReturnEditBeginCmdImpl()

Method Detail

performExecute

public void performExecute()
                    throws ECException

This method is the main logic for setting up the RMA for edits.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Specified by:

performExecute in class ReturnEditBaseCmdImpl

Throws:

ECException

See Also:

TargetableCommand.performExecute()

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECException

Sets the request properties of this command implementation.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ReturnEditBaseCmdImpl

Parameters:

reqProperties - the request properties

Throws:

ECException

See Also:

ControllerCommand.setRequestProperties(com.ibm.commerce.datatype.TypedProperty)

setTakeOverLock

public void setTakeOverLock(java.lang.String takeOverLock)

This method sets if take over lock from others.

Specified by:

setTakeOverLock in interface ReturnEditBeginCmd

Parameters:

takeOverLock - It should be "Y" or "N".

validateParameters

public void validateParameters()
                        throws ECException

Extracts and validates the input parameters of this command implementation if validated, locks the RMA.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class ReturnEditBaseCmdImpl

Throws:

ECException

See Also:

ECCommand.validateParameters()