com.ibm.commerce.order.commands

Class OrderDisplayCmdImpl

  • All Implemented Interfaces:
    AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, OrderDisplayCmd, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

    public class OrderDisplayCmdImpl
extends OrderPrepareBaseImpl
implements OrderDisplayCmd
    This is the default implementation of the OrderDisplayCmd controller command.

    Behaviour:

    • It displays the contents of the specified orders. If order reference numbers are not specified, displays the list of orders that match the status input parameter. If the status parameter is not specified, it defaults to "P'.
    • If any of the Orders are not locked, calls the OrderPrepare controller command to prepare them.
    • It sets the "viewTaskName" response property to "OrderDisplayPendingView", if the status input parameter is "P", "I", "E", or unspecified. Otherwise sets it to "OrderDisplayCompletedView" (unless it is "X", which is not allowed).

    Input parameters:

    Name Description
    langId Sets or resets the preferred language for the duration of the session; the supported languages for a store are found in the STORELANG table.
    forUser The logon ID of the user on whose behalf the command runs; only a person with the authority to process orders can specify this parameter.
    forUserId Same as forUser, but identifying the user by the internal user ID as found in the USERS table.
    storeId The store that is associated with the order.
    outOrderName The name-value pairs to be passed to a JSP. The value of each added name-value pair is the reference number of the order to be displayed. If the name is not provided, the default name (orderId) is used.
    status (The status of the orders that are listed. If the status is missing, it is assumed to be set to P (pending). It is only with pending orders that abbreviations may be used with orderId. The status may not be set to X.
    orderId The reference number of the order to be displayed. If this parameter is omitted, the OrderDisplay command behaves as if all of the customer's orders for the specified store were included. Abbreviations can be used, but only with pending orders. See the Order abbreviations for a description of the abbreviations. This parameter can be repeated.
    remerge A list of the order items that are to be merged with other order items in the same order and with the same correlationGroup attribute if possible. This parameter can be repeated.
    merge A list of order items that are to be merged with other order items in the same order if possible, regardless of their correlationGroup attributes. This parameter can be repeated.
    check A list of order items that are to be checked by the CheckInventory task command. This parameter can be repeated.
    allocate A list of order items that are to be allocated from existing inventory. This parameter can be repeated.
    backorder A list of order items that are to be allocated from expected inventory. This parameter can be repeated.
    reverse A list of order items whose allocations are to be released (that is, de-allocated from existing or expected inventory as appropriate). This parameter can be repeated.

    Output parameters:

    None.

    Task commands called:

    See Also:
    Serialized Form

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • OrderDisplayCmdImpl

        public OrderDisplayCmdImpl()

    • Method Detail

      • performExecute

        public void performExecute()
                    throws ECException
        This method executes the business logic of this command implementation.

        Behaviour:
        • Check that the specified Orders exist.
        • If any of the specified Orders are not locked, and the status input parameter specifies "P", "I", or "E", call the OrderPrepare controller command to prepare them.
        • Set the "viewTaskName" response property to "OrderDisplayPendingView", if the status input parameter is "P", "I", "E", or unspecified. Otherwise set it to "OrderDisplayCompletedView".
        • Add response properties whose values are the identifiers of the Orders to be displayed, and whose names are specified by the outOrderName input parameter.

        Specified by:
        performExecute in interface ECCommand
        Specified by:
        performExecute in interface com.ibm.websphere.command.TargetableCommand
        Overrides:
        performExecute in class OrderPrepareBaseImpl
        Throws:
        ECException -
        See Also:
        ECCommand.performExecute()
Skip navigation links