ReturnReasonCodeCreateCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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, 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 identifier 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

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT`
`static java.lang.String`	`defaultCommandClassName` The default implementation class name.
`static java.lang.String`	`NAME`

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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
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
```
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    See Also:
    
    Constant Field Values
  - defaultCommandClassName
```
static final java.lang.String defaultCommandClassName
```
    The default implementation class name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - setReturnReasonCode
```
void setReturnReasonCode(java.lang.String newReturnReasonCode)
```
    Set the return reason code.
    
    Parameters:
    
    newReturnReasonCode - java.lang.String
  - setReturnReasonDescription
```
void setReturnReasonDescription(java.lang.String newReturnReasonDescription)
```
    Set the description of the reason for the return.
    
    Parameters:
    
    newReturnReasonDescription - java.lang.String
  - setReturnReasonType
```
void setReturnReasonType(java.lang.String newReturnReasonType)
```
    Set the type of return reason code.
    
    Parameters:
    
    newReturnReasonType - java.lang.String