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

Interface CSRCustomerAddressAddCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, ToolsControllerCommand
    All Known Implementing Classes:
    CSRCustomerAddressAddCmdImpl


    public interface CSRCustomerAddressAddCmd
    extends ToolsControllerCommand
    Creates a new address on behalf of the customer.

    Behavior

    • Calls AddressUpdateCmd controller command with forUser parameter set to customerId which is specified in the xml_string

    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>
                    </xml>
     
    URL
    The URL to be called when the command completes successfully.

    Response Parameters

    addressId
    Return the address ID for the customer.

Exception Conditions

Error View:

  • CSRCustomerAddressAddErrorView
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class name.
        See Also:
        Constant Field Values
    • Method Detail

      • getAddressId

        java.lang.String getAddressId()
        Gets the address ID. This address ID is appended to success redirect URL.
        Returns:
        The address ID.