com.ibm.commerce.inventory.commands
Interface ReturnReasonCodeCreateCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Implementing Classes:
ReturnReasonCodeCreateCmdImpl

public interface ReturnReasonCodeCreateCmd
extends ToolsControllerCommand

Create a new return reason.

This command requires to have the store entity id and language id set in the command context.

Parameters

EC_XMLObject
An input xml_string that contains all required data for creating a new return reason.

Example xml_string for return reason:

<?xml version="1.0" encoding="UTF-8"?> <XML> <XMLFile>inventory.ReturnReasonDetail</XMLFile> <code>Return reason code1</code> <description>Return reason code description</description> <reasonType>B</reasonType> </XML>
URL
The URL to be called when the command completes successfully.

Response Parameters

rtnreasonId
Return the identifer of the return reason code.

Exceptions

When the required fields are missing or not in the right data type, this command will throw exception to indicate which field is missing or bad.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
           
 
Method Summary
 void setReturnReasonCode(java.lang.String newReturnReasonCode)
          Set the return reason code.
 void setReturnReasonDescription(java.lang.String newReturnReasonDescription)
          Set the description of the reason for the return.
 void setReturnReasonType(java.lang.String newReturnReasonType)
          Set the type of return reason code.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name.

NAME

public static final java.lang.String NAME
Method Detail

setReturnReasonCode

public void setReturnReasonCode(java.lang.String newReturnReasonCode)
Set the return reason code.
Parameters:
newReturnReasonCode - java.lang.String

setReturnReasonDescription

public void setReturnReasonDescription(java.lang.String newReturnReasonDescription)
Set the description of the reason for the return.
Parameters:
newReturnReasonDescription - java.lang.String

setReturnReasonType

public void setReturnReasonType(java.lang.String newReturnReasonType)
Set the type of return reason code.
Parameters:
newReturnReasonType - java.lang.String