com.ibm.commerce.returns.commands

Interface ReturnPrepareCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

ReturnPrepareCmdImpl

public interface ReturnPrepareCmd
extends ControllerCommand

This command is used to get a return merchandise authorization (RMA) terms ready for agreement.

Controller command URL calling syntax

https://host_name/path/ReturnPrepareCmd?RMAId=RMAId_value&URL=redirect_url&commment=comment_value

Parameters

RMAId (mandatory)

The Id of the RMA for which to create final terms.

comment (optional)

The textual additions to the RMA.

URL (mandatory)

The URL to be called when the command completes successfully.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation class name is "com.ibm.commerce.returns.commands.ReturnPrepareCmdImpl".
static java.lang.String	NAME The name of this interface is "com.ibm.commerce.returns.commands.ReturnPrepareCmd".

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
MonetaryAmount	getRMATotalCredit() This method gets the total RMA Credit

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

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, performExecute, 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, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this interface is "com.ibm.commerce.returns.commands.ReturnPrepareCmd".

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class name is "com.ibm.commerce.returns.commands.ReturnPrepareCmdImpl".

See Also:

Constant Field Values

Method Detail

getRMATotalCredit

MonetaryAmount getRMATotalCredit()

This method gets the total RMA Credit

Returns:

the total RMA Credit