com.ibm.commerce.tools.optools.order.beans

Class OrderSummaryDataBean

    • Field Detail

      • COPYRIGHT

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

      • OrderSummaryDataBean

        public OrderSummaryDataBean()
    • Method Detail

      • getBillingAddressId

        public java.lang.String getBillingAddressId()

        This method returns the order's billing address id.

        Returns:
        String The billing address id
      • getCouponDisplayList

        public java.lang.String getCouponDisplayList()

        This method returns a displayable string that contains all the coupons used for this order.

        Returns:
        String The displayable list of coupons ids
      • getEstimatedShipDate

        public java.lang.String getEstimatedShipDate()

        This method returns a NL friendly estimated ship date of the order.

        Returns:
        String The NL friendly estimated ship date of the order
      • getLastUpdate

        public java.lang.String getLastUpdate()

        This method returns a NL friendly lastupdate date of the order.

        Returns:
        String The NL friendly lastupdate date of the order
      • getLogonID

        public java.lang.String getLogonID()

        This method returns the order's customer's logon id.

        Returns:
        String The customer logon id
      • getOrderCurrency

        public java.lang.String getOrderCurrency()

        This method returns the currency of the order.

        Returns:
        String The currency of the order
      • getOrderGrandTotal

        public java.lang.String getOrderGrandTotal()

        This method returns the formatted order total.

        Returns:
        String The formatted order total
      • getOrderId

        public java.lang.String getOrderId()

        This method returns the order id.

        Returns:
        String The order id
      • getOrderItem

        public OrderItemDataBean getOrderItem(int index)

        This method returns the order item data bean at the specified index.

        Parameters:
        index - The index of the order item
        Returns:
        String The order item data bean
      • getOrderItemActualShipDate

        public java.lang.String getOrderItemActualShipDate(int index)

        This method returns the formatted actual ship date for the order item.

        Parameters:
        index - The index of the order item
        Returns:
        String The formatted actual ship date of the order item
      • getOrderItemContractName

        public java.lang.String getOrderItemContractName(int index)

        This method returns the contract name for the order item.

        Parameters:
        index - The index of the order item
        Returns:
        String The contract name of the order item
      • getOrderItemDistinctShippingAddressIds

        public java.lang.String[] getOrderItemDistinctShippingAddressIds()

        This method returns all the distinct shipping addresses.

        Returns:
        String The array of distinct shipping addresses
      • getOrderItemIndex

        public java.lang.Integer[] getOrderItemIndex(java.lang.String shipAddressId)

        This method returns the indexes of the order items that have the specified addressId.

        Parameters:
        shipAddressId - The address id
        Returns:
        String The array of indexes
      • getOrderItemIndexWithNoShipAddress

        public java.lang.Integer[] getOrderItemIndexWithNoShipAddress()

        This method returns the indexes of the order items that do not have addressId.

        Returns:
        String The array of indexes
      • getOrderItemLevelDiscountForDisplay

        public java.lang.String getOrderItemLevelDiscountForDisplay(int index)

        This method returns the formatted order item level discount.

        Parameters:
        index - The index of the order item
        Returns:
        String The formatted order item level discount
      • getOrderItemName

        public java.lang.String getOrderItemName(int index)

        This method returns the product name of the order item.

        Parameters:
        index - The index of the order item
        Returns:
        String The product name
      • getOrderItemPrice

        public java.lang.String getOrderItemPrice(int index)

        This method returns the price the order item.

        Parameters:
        index - The index of the order item
        Returns:
        String The product's price
      • getOrderItemQuantity

        public java.lang.String getOrderItemQuantity(int index)

        This method returns the quantity of the order item.

        Parameters:
        index - The index of the order item
        Returns:
        String The quantity
      • getOrderItems

        public OrderItemDataBean[] getOrderItems()
                                          throws java.lang.Exception

        This method returns all the order items.

        Returns:
        String The array of OrderItemDataBean
        Throws:
        java.lang.Exception
      • getOrderItemShippingAddressId

        public java.lang.String getOrderItemShippingAddressId(int index)

        This method returns the addressId of the order item at that index.

        Parameters:
        index - The index of the order item
        Returns:
        String The address id
      • getOrderItemShippingMethod

        public java.lang.String getOrderItemShippingMethod(int index)

        This method returns the shipping method description of the order item at that index.

        Parameters:
        index - The index of the order item
        Returns:
        String The shipping method description
      • getOrderItemSKU

        public java.lang.String getOrderItemSKU(int index)

        This method returns the SKU of the order item at that index.

        Parameters:
        index - The index of the order item
        Returns:
        String The SKU
      • getOrderItemsSize

        public int getOrderItemsSize()

        This method returns the total number of order items in the order.

        Returns:
        String The total number of order items
      • getOrderItemSubTotal

        public java.lang.String getOrderItemSubTotal(int index)

        This method returns the formmatted amount of the subtotal of the order item at that index.

        Parameters:
        index - The index of the order item
        Returns:
        String The formatted order item subtotal
      • getOrderLevelDiscountForDisplay

        public java.lang.String getOrderLevelDiscountForDisplay()

        This method returns the formatted order level discount.

        Returns:
        String The formatted order level discount
      • getOrderLevelMinusAdjustment

        public java.lang.String getOrderLevelMinusAdjustment()

        This method returns the formatted order level adjustment.

        Returns:
        String The formatted order level adjustment
      • getOrderStatus

        public java.lang.String getOrderStatus()

        This method returns the order status.

        Returns:
        String The status of the order
      • getOrganizationName

        public java.lang.String getOrganizationName()

        This method returns the name of the organization that the customer of the order belongs to.

        Returns:
        String The organization name
      • getPaymentMethodDescription

        public java.lang.String getPaymentMethodDescription()

        This method returns the payment method description used to capture the order.

        Returns:
        String The payment method description
      • getPaymentOfflineMethod

        public java.lang.String getPaymentOfflineMethod(java.lang.String anOrderId)

        This method returns the offline payment method.

        Parameters:
        anOrderId - An order id
        Returns:
        String The offline payment method
      • getPlaceOrderTime

        public java.lang.String getPlaceOrderTime()

        This method returns the order timeplaced.

        Returns:
        String The date and time when the order was placed
      • getPurchaseOrderNumber

        public java.lang.String getPurchaseOrderNumber()

        This method returns the purchase order number.

        Returns:
        String The purchase order number
      • getFormattedTotalProductPrice

        public java.lang.String getFormattedTotalProductPrice()

        This method returns the formatted total product amount.

        Returns:
        String The formatted total product amount
      • getFormattedTotalShippingCharges

        public java.lang.String getFormattedTotalShippingCharges()

        This method returns the formatted shipping charges amount.

        Returns:
        String The formatted shipping charges amount
      • getFormattedTotalShippingTax

        public java.lang.String getFormattedTotalShippingTax()

        This method returns the formatted shipping taxes amount.

        Returns:
        String The formatted shipping taxes amount
      • getFormattedTotalTax

        public java.lang.String getFormattedTotalTax()

        This method returns the formatted total tax amount.

        Returns:
        String The formatted total tax amount
      • ifActualShipDateExist

        public boolean ifActualShipDateExist()

        Check that if any of the order items in the order has an actual ship date.

        Returns:
        boolean True or False
      • populate

        public void populate()
                      throws java.lang.Exception

        Populates the bean with relevant information of the order.

        You must set the OrderId using the setOrderId method before running the populate() method.
        Specified by:
        populate in interface SmartDataBean
        Overrides:
        populate in class SmartDataBeanImpl
        Throws:
        java.lang.Exception
        See Also:
        setOrderId(String)
      • setOrderId

        public void setOrderId(java.lang.String newOrderId)

        This method sets the order id.

        Parameters:
        newOrderId - The order id