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

Interface CSROrderItemSplitCmd

  • 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:
    CSROrderItemSplitCmdImpl


    public interface CSROrderItemSplitCmd
    extends ToolsControllerCommand
    Moves order items from one order to the other.

    Behavior

    • Moves order items from one order to the other by calling OrderItemMoveCmd.
    • If the target order id, toOrderId, is not specified, all items will be moved to a new order.
    • The status of the new order and its items will be changed to "E" and the id of the new order will be returned.

    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 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 Parameter:

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

    Exception Conditions

    Throws all exceptions that thrown by CSROrderStatusChangeCmd and OrderItemMoveCmd.

    Error View:

    • CSROrderItemSplitErrorView
    • 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.
        See Also:
        Constant Field Values