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

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

public interface CSROrderRollBackCmd
extends ToolsControllerCommand


 Change the first order so that it will contain the same order items as those order items in the backup order.
 Set the shipping charge and menu adjustment of the first order as those values provided by the XML.

 After the changes made to the first order is done, the command will call command OrderPrepare and OrderProcess to prepare and process the first order.

 After the first order being reprepared and reprocessed and the grand totoal of the first order is different from the value in the XML, the command will return a warning message.

 If the second order exists, this command will cancel the second order.
 Remove the backup order when the roll back is complete.  If the command fail to remove the backup order, the command will return a warning message.

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

 Parameters:
	XML
		An input xml_string that contains the details of the order which has changes need to be rollbacked.

		Example xml_string:
			<?xml version="1.0" encoding "UTF-8">
				<order>
					<customerId>		20000	</customerId>
					<billingAddressId>	1000	</billingAddressId>
					<firstOrder>
						<id>		10001	</id>
					</firstOrder>
					<secondOrder>
						<id>		10002	</id>
					</secondOrder>
					<backupOrder>
						<id>		10002	</id>
						<totalShipping>
					    		<value>0.0</value>
						</totalShipping>
						<totalAdjustment>
					    	    <value>0.0</value>
					    	</totalAdjustment>
						<couponIds>123456</couponIds>
						<grandTotal>10000</grandTotal>

					</backupOrder>
				</order>
			</xml>


	URL
		The URL to be called when the command completes successfully

 Response Parameters:
 	None

 Exceptions:
 	It throws all the exceptions thrown by OrderItemAdd, OrderItemUpdate, OrderItemDelete, OrderPrepare, OrderProcess, OrderProcess, CSROrderCancel and DoCancel commands 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.CSROrderRollBackCmd".
 
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.CSROrderRollBackCmd".