com.ibm.commerce.tools.optools.order.commands

Interface CSROrderItemAddCmd

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:

CSROrderItemAddCmdImpl

public interface CSROrderItemAddCmd
extends ToolsControllerCommand

Adds one or more order items to an order.

Behavior

• Add items to the order if the order ID is specified. Otherwise, the items will be added to a new order
• If shipModeId and shipAddrId are optional. If shipModeId is not provided, the store default shipping mode will be used.
• Change the status of the order and its order items to 'E' state.

Parameters

XML

An input xml_string that contains all the required data for one or many order items.

 Example xml_string:
        <?xml version="1.0" encoding "UTF-8">
        <order>
                <customerId>10001</customerId>
                <orderId>10001</orderId>
        </order>
        <orderItem>
                <catentryId>1003</catentryId>
                <quantity>1.0</quantity>
                <shipModeId>30001</shipModeId>
                <tradingId>1.0</tradingId>
                <shipAddrId>30001</shipAddrId>
        </orderItem>
        </xml>    
 

URL

The URL to be called when the command completes successfully.

Response Parameter:

orderId

Return the order Id of the order item(s) added to.

Exception Conditions

Throws all exceptions that thrown by OrderItemAddCmd and CSROrderStatusChangeCmd.

Error View:

• CSROrderItemAddErrorView

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.
static java.lang.String	NAME The name of this command.

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

serialVersionUID

Method Summary

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 command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation class.

See Also:

Constant Field Values