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

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, ToolsControllerCommand
All Known Implementing Classes:
CSROrderPrepareCmdImpl

public interface CSROrderPrepareCmd
extends ToolsControllerCommand

Calls OrderPrepareCmd to prepare orders on behalf of customer. This command can prepare at most two orders.

Behavior

Parameters

XML
An input xml_string that contains the details of the orders which will be prepared.
 Example xml_string:
  <?xml version="1.0" encoding "UTF-8">
    <order>
      <customerId>20000 </customerId>
      <firstOrder>
        <id>10001</id>
      </firstOrder>
      <secondOrder>
        <id>10002</id>
      </secondOrder>
    </order>
  </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 are thrown by OrderCalculateCmd and OrderPrepareCmd.

Error View:


Field Summary
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.
 
Method Summary
 java.lang.String getCustomerId()
          Gets the customer ID.
 java.lang.String getFirstOrderId()
          Gets the first order ID.
 java.lang.String getSecondOrderId()
          Gets the second order ID.
 
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.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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this command.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class.
See Also:
Constant Field Values
Method Detail

getCustomerId

public java.lang.String getCustomerId()
Gets the customer ID. The customer ID is also appended to success redirect URL.
Returns:
The customer ID.

getFirstOrderId

public java.lang.String getFirstOrderId()
Gets the first order ID. The first order ID is also appended to success redirect URL.
Returns:
The first order ID.

getSecondOrderId

public java.lang.String getSecondOrderId()
Gets the second order ID. The second order ID is also appended to success redirect URL.
Returns:
The second order ID.