com.ibm.commerce.ordermanagement.commands

Interface AdvancedOrderEditBeginCmd

  • 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:
    AdvancedOrderEditBeginCmdImpl, SOIAdvancedOrderEditBeginCmdImpl


    public interface AdvancedOrderEditBeginCmd
    extends ControllerCommand
    This order controller command is used to brings an order into editing mode (major status=EDT).

    This AdvancedOrderEditBeginCmd implementation class and AdvancedOrderEditEndCmd command stage an advanced order for editing. Between the execution of the AdvancedOrderEditBeginCmd and AdvancedOrderEditEndCmd 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 command context. After the command is invoked, the order is in an editable state. Orders that are in cancel (CAN) or close (CLS) state cannot be edited. An exception is thrown if an invalid order is passed. The command also requires that a qualified editorId be passed. The editorId must be a registered member; otherwise, an exception is thrown.

    If the command is successful, the major status of an order will be set to EDT. 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 AdvancedOrderEditBeginCmdImpl. }. The AdvancedOrderEditBegin 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
        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)
        This method sets an order ID, a required field, for edit.
        Parameters:
        strOrderId - as a String of a valid orderId
      • setOrder

        void setOrder(OrderAccessBean abOrder)
        This method sets an order ID, a required field, for edit.
        Parameters:
        abOrder - as a String of a valid orderId
      • getOrderVersion

        java.lang.Short getOrderVersion()
        This method returns the order version number.
        Returns:
        the order version number.
      • setTakeOverLock

        void setTakeOverLock(java.lang.String takeOverLock)
        This method sets take over lock parameter.
        Parameters:
        takeOverLock -