com.ibm.commerce.price.commands

Interface GetStandardOfferCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand
    All Known Implementing Classes:
    GetStandardOfferCmdImpl


    public interface GetStandardOfferCmd
    extends com.ibm.commerce.command.TaskCommand
    Interface for the command used for retrieving the standard offer price of a product.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      The default name of this command.
      static java.lang.String NAME
      The name of this command.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      MonetaryAmount[] getBasePrices()
      Gets the prices for the given catlog entries with the currency specified in the database table.
      java.lang.Long[] getOfferIds() 
      com.ibm.commerce.order.objects.OfferAccessBean[] getOffers() 
      MonetaryAmount[] getPrices()
      Gets the prices for the given catlog entries with the requested currency.
      MonetaryAmount[] getUnitPrices()
      This method returns all the single unit standard price, which is based on an offer.
      void setCatEntryIds(java.lang.Long[] catEntryIds)
      Sets the catalog entry IDs whose price are to be retrieved.
      void setCurrency(java.lang.String currency)
      Set the currency to be used for finding the price.
      void setOrderItemAccessBeans(com.ibm.commerce.order.objects.OrderItemAccessBean[] orderItemABs)
      Sets the order item access beans.
      void setPolicyPriceListType(java.lang.String policyPriceListTypeToUse)
      (Optional) Sets the price list type of the business policy to use in retrieving price lists.
      void setQuantities(QuantityAmount[] quantityAmounts)
      Set the quantity amount of each catalog entry that is to be priced.
      void setStoreId(java.lang.Integer storeId) 
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute
      • Methods inherited from interface com.ibm.commerce.command.ECCommand

        checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
    • 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 name of this command.
        See Also:
        Constant Field Values
    • Method Detail

      • getBasePrices

        MonetaryAmount[] getBasePrices()
        Gets the prices for the given catlog entries with the currency specified in the database table.
        Returns:
        A set of PriceDataBeans priced for the catalog entries.
      • getOfferIds

        java.lang.Long[] getOfferIds()
      • getOffers

        com.ibm.commerce.order.objects.OfferAccessBean[] getOffers()
      • getPrices

        MonetaryAmount[] getPrices()
        Gets the prices for the given catlog entries with the requested currency.
        Returns:
        A set of PriceDataBeans priced for the catalog entries.
      • getUnitPrices

        MonetaryAmount[] getUnitPrices()
        This method returns all the single unit standard price, which is based on an offer.
        Returns:
        an Array of offer unit price.
      • setCatEntryIds

        void setCatEntryIds(java.lang.Long[] catEntryIds)
        Sets the catalog entry IDs whose price are to be retrieved.
        Parameters:
        catEntryIds - a set of the reference numbers of catalog entries.
      • setCurrency

        void setCurrency(java.lang.String currency)
        Set the currency to be used for finding the price. If the currency is not specified then the "negotiated" currency is used for the store Id and shopper's preferred currency. (The negotiated currency is the currency returned from the getCurrency() method of the currency manager).
        Parameters:
        aCurrency - the currency.
      • setOrderItemAccessBeans

        void setOrderItemAccessBeans(com.ibm.commerce.order.objects.OrderItemAccessBean[] orderItemABs)
        Sets the order item access beans.
        Parameters:
        orderItemABs - an array of order item access bean
      • setPolicyPriceListType

        void setPolicyPriceListType(java.lang.String policyPriceListTypeToUse)
        (Optional) Sets the price list type of the business policy to use in retrieving price lists. If this value is set then only policies with this type in their properties will be used to find price lists.
        Parameters:
        policyPriceListTypeToUse - the policy price list type to use in retrieving price lists.
      • setQuantities

        void setQuantities(QuantityAmount[] quantityAmounts)
        Set the quantity amount of each catalog entry that is to be priced. The quantity amount helps determine which offers are valid. If the quantity amount is not specified then the nominal quantity (rounded up to the nearest multiple as specified in the quantityMultiple attribute) of the Catalog entry is assumed to be the requested quantity.
        Parameters:
        aQuantityAmount - a quantity amount.
      • setStoreId

        void setStoreId(java.lang.Integer storeId)