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

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

public interface CSROrderPrepareCmd
extends ToolsControllerCommand


 Prepare pending order(s) by calling OrderPrepare command.
 This command will prepare at most two orders.

 URL calling syntax:
		Https://host_name/path/CSROrderPrepare?XML=xml_string&URL=return_url

 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 Parameters:
		None

 Exceptions:
		It throws all the exceptions that the OrderPrepare command will throw.



Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class.
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.tools.optools.order.commands.CSROrderPrepareCmd".
 
Method Summary
 java.lang.String getCustomerId()
          Return customer ID.
 java.lang.String getFirstOrderId()
          Return first order ID.
 java.lang.String getSecondOrderId()
          Return second order ID.
 
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

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.tools.optools.order.commands.CSROrderPrepareCmd".
Method Detail

getCustomerId

public java.lang.String getCustomerId()
Return customer ID. The customer ID also appends to success redirect URL.
Returns:
java.lang.String

getFirstOrderId

public java.lang.String getFirstOrderId()
Return first order ID. The first order ID also appends to success redirect URL.
Returns:
java.lang.String

getSecondOrderId

public java.lang.String getSecondOrderId()
Return second order ID. The second order ID also appends to success redirect URL.
Returns:
java.lang.String