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

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

public interface CSROrderProcessCmd
extends ToolsControllerCommand


 Process an order on behalf of the customer.

 If the process is creating order(finish action in the Place Order wizard), this
 command will first do the adjustments by calling CSROrderAdustmentUpdateCmd if
 applicable, then process the pending order(s) and complete the order(s) by calling
 OrderProcessCmd, finally add comments.

 If the process is editing old order(ok button in the Change order notebook), this
 command will do the order prepare by calling CSROrderPrepareCmd if it's needed,
 then process the order and complete the original Order by calling OrderProcessCmd,
 finally add comments and delete the backup order.

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

 Parameters:
 	XML
		An input xml_string that contains all required data for creating the new order
		on behalf of the customer.

		Example xml_string:
			<?xml version="1.0" encoding "UTF-8">
			<order>
				<customerId>20000</customerId>
				<originatorId>1000</originatorId>
				<comment>
					<value>This is a comment.</value>
					<sendEmail>true</sendEmail>
					<emailAddress>abc@mail.com</emailAddress>
				</comment>
				<firstOrder>
					<id>10001</id>
					<billingAddressId>10001</billingAddressId>
					<dirtyBit>true</dirtyBit>
					<totalShipping>
						<value>0.0</value>
					</totalShipping>
					<totalAdjustment>
						<value>0.0</value>
					</totalAdjustment>
					<couponIds>
						<value>20.0</value>
					</couponIds>
					<payment>++
						<policyId>200</policyId>
						<paymentTCId>34</paymentTCId>
						<description>Credit Card(Offline) - VISA</description>
						<buyPageInfo>StandardCreditCard</buyPageInfo>
						<cardBrand>VISA</cardBrand>
						<cardNumber>2222222222</cardNumber>
						<cardExpiryMonth>2002</cardExpiryMonth>
						<cardExpiryYear>2002</cardExpiryYear>
					</payment>
				</firstOrder>
				<secondOrder>
					<id>10002</id>
					<billingAddressId>10001</billingAddressId>
					<dirtyBit>false</dirtyBit>
					<totalShipping>
						<value>0.0</value>
					</totalShipping>
					<totalAdjustment>
						<value>0.0</value>
					</totalAdjustment>
					<couponIds>
						<value>20.0</value>
					</couponIds>
					<payment>++
						<policyId>200</policyId>
						<paymentTCId>34</paymentTCId>
						<description>Credit Card(Offline) - VISA</description>
						<buyPageInfo>StandardCreditCard</buyPageInfo>
						<cardBrand>VISA</cardBrand>
						<cardNumber>2222222222</cardNumber>
						<cardExpiryMonth>2002</cardExpiryMonth>
						<cardExpiryYear>2002</cardExpiryYear>
					</payment>
				</secondOrder>
			</order>
			<editOrderInfo>true</editOrderInfo>
			</xml>

 	URL
		The URL to be called when the command completes successfully

	++ NOTE: payment object tags will vary depending on the payment method selected.

 Response Parameters:
	None.

 Exceptions:
	It throws all the exceptions that the OrderProcessCmd will throw.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
           
 
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.

NAME

public static final java.lang.String NAME