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

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

public interface CSROrderItemAddressUpdateCmd
extends ToolsControllerCommand

 Updates the address ID of the order item on behalf of the customer.
 If shippingAddressId is not provided, create a new address for the
 customer by calling CSRCustomerAddressAddCmd. Once obtaining the
 address Id, update the OrderItem by calling OrderItemUpdateCmd.

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

 Parameters:
 	XML
 		An input xml_string that contains the all required data for creating the new
 		address for the customer.

 		Example xml_string:
 			<?xml version="1.0" encoding "UTF-8">
 			<order>
 				<customerId>20000</customerId>
 			</order>
 			<address>
 				<addrType>SB</addrType>
 				<nickName>Home</nickName>
 				<lastName>ABC</lastName>
 				<firstName>XYZ</firstName>
 				<address1>8200 Warden Ave.</address1>
 				<address2>A3 - 999</address2>
 				<city>Markham</city>
 				<region>Ontario</region>
 				<country>Canada</country>
 				<postalCode>L3N 3R6</postalCode>
 				<phoneNumber>905-413-1234</phoneNumber>
 				<email>abc@mail.com</email>
 			</address>
 			<orderItem>
 				<orderId>10001</orderId>
 				<orderItemId>10110</orderItemId>
 				<shipAddrId>20002</shipAddrId>
				</orderItem>
 			</xml>

 	URL
 	 	The URL to be called when the command completes successfully

 	Note: If inside <orderItem> tag there is no <shipAddrId>, the <address>
 		block must be provided.

 Behaviors:
 	If shippingAddressId is not provided, create a new address for the
 	customer by calling CSRCustomerAddressAddCmd. Once obtaining the address Id,
 	update the OrderItem by calling OrderItemUpdateCmd.

 Response Parameters:
 	None.

 Exceptions:
 	It throws all the exceptions that the CSRCustomerAddressAddCmd and
 	OrderItemUpdateCmd will throw and specifies CSROrderItemAddressUpdateErrorView
 	error view command.

 


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