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

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

public interface CSROrderItemSplitCmd
extends ToolsControllerCommand

 Group a set of order items into one order by calling OrderItemMove command.
 This command will move the order item from one order to another order.
 If the value of the parameter toOrderId is not specified, this command will create a new order and move the order items to the new order.
 If a new order is created, this command will change the status of the new order and its order items to 'E' state.

 URL calling syntax:
		Https://host_name/path/CSROrderItemSplit?XML=xml_string&toOrderId=10001&fromOrderId=10002&URL=return_url

 Parameters:
		XML
			An input xml_string that contains the details of the order items which will be moved.

			Example xml_string:
				<?xml version="1.0" encoding "UTF-8">
				<order>
					<customerId>		20000	</customerId>
				</order>
				<orderItem>
					<orderId>	10002		</orderId>
					<orderItemId>	10110		</orderItemId>
				</orderItem>
				<orderItem>
					<orderId>	10002		</orderId>
					<orderItemId>	10220		</orderItemId>
				</orderItem>
				</xml>

		toOrderId:
			The ID of the order which the order items will be moved to.  If the value of this parameter is null or empty, this command will create a new order and move these order items to this new order.

		fromOrderId;
			Only those order items of the order with this order ID need to be moved.


		URL
			The URL to be called when the command completes successfully

 Response Parameters:
		secondOrderId
			Return the ID of the new order created.  This will only happen when the value of the input parameter toOrderId is null or empty.

 Exceptions:
		It throws all the exceptions that the OrderItemMove 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.CSROrderItemSplitCmd".
 
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.CSROrderItemSplitCmd".