com.ibm.commerce.ordermanagement.commands

Interface AdvancedOrderEditEndCmd

  • 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
    All Known Implementing Classes:
    AdvancedOrderEditEndCmdImpl


    public interface AdvancedOrderEditEndCmd
    extends ControllerCommand
    This order controller command is used to close editing of the order and remove the EDITOR_ID from the order in the ORDERS table.

    The AdvancedOrderEditEndCmd implementation class and AdvancedOrderEditBeginCmd stage an advanced order for editing. Between the execution of the AdvancedOrderEditBeginCmd and AdvancedOrderEndCmd commands, many types of order editing actions can occur (for example, OrderItemUpdateCmd, PIEdit, OrderCopy, and so on.).

    To invoke this command, a valid order ID has to be passed in from the command context. The order shall be in an editable state. Orders that are in cancel (X) or close (D) state cannot be edited. An exception is thrown if an invalid order ID is passed.

    If the command is successful, the editorId of the order will be NULL. And the order will not be processed by the system until the order gets submitted again.

    If unsuccessful, the command throws the ECException.

    The default implementation of this command is AdvancedOrderEditEndCmdImpl.
    The AdvancedOrderEditEnd URL is mapped to this command by default.

    • Field Detail

      • COPYRIGHT

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

        static final java.lang.String EC_ORDER_RN
        The URL parameter constant.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The full name of this command.
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values
    • Method Detail

      • setOrderId

        void setOrderId(java.lang.String strOrderId)
        Sets an order ID, which is a required field, for edit.
        Parameters:
        strOrderId - as a String of a valid orderId