com.ibm.commerce.price.commands

Interface GetContractPriceListCmd

  • 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:
    GetContractPriceListCmdImpl


    public interface GetContractPriceListCmd
    extends com.ibm.commerce.command.TaskCommand
    Interface for the GetContractPriceListCmd Task Command to calculate the contract price for a catalog entry given a trading agreements id.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String NAME
      The name of this command.
      • Fields inherited from interface com.ibm.commerce.command.CacheableECCommand

        defaultCommandClassName
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      MonetaryAmount getApplicableTradingUnitPrice()
      Returns the unit price of a catentry that were determined for each of the applied trading agreements.
      java.lang.Long getTcId()
      Returns the id of the output T&C id which was associated with the offer that supplied the price.
      java.lang.Long getTradingId()
      Returns the trading id that used to calculate the contract price.
      void setCatEntryId(java.lang.Long catEntryId)
      Sets the catEntry id for command calculation
      void setContractIds(java.lang.Long[] contractIds)
      Sets the contracts ids for basecommand calculation
      void setCurrency(java.lang.String astrCurrency)
      Sets the currency to be used for finding the price (Optional).
      void setOrderItemComponentAccessBean(com.ibm.commerce.order.objects.OrderItemComponentAccessBean oICAB)
      Sets order item access bean which passed in.
      void setQuantity(QuantityAmount quantity)
      Sets the quantity for command calculation
      void setTradingIds(java.lang.Long[] aTradingIds)
      Sets the ids of the input trading agreements (Optional).
      • 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
    • Method Detail

      • getApplicableTradingUnitPrice

        MonetaryAmount getApplicableTradingUnitPrice()
        Returns the unit price of a catentry that were determined for each of the applied trading agreements.
        Returns:
        The unit price amount of a catentry in that each of them was determined individually for its corresponding trading agreement.
      • getTcId

        java.lang.Long getTcId()
        Returns the id of the output T&C id which was associated with the offer that supplied the price.
        Returns:
        The reference number of the T&C that was used to determine the price.
      • getTradingId

        java.lang.Long getTradingId()
        Returns the trading id that used to calculate the contract price.
        Returns:
        The trading id used to calculate the contract price.
      • setCatEntryId

        void setCatEntryId(java.lang.Long catEntryId)
        Sets the catEntry id for command calculation
        Parameters:
        catEntryIds - The reference numbers of a catEntry to be used to determine the offers that will supply the prices and the adjustments to be applied to the prices.
      • setContractIds

        void setContractIds(java.lang.Long[] contractIds)
        Sets the contracts ids for basecommand calculation
        Parameters:
        contractIds - The reference numbers of a list of trading agreements to be used to determine the offers that will supply the prices and the adjustments to be applied to the prices.
      • setCurrency

        void setCurrency(java.lang.String astrCurrency)
        Sets the currency to be used for finding the price (Optional).
        Parameters:
        astrCurrency - The currency to look up 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).
      • setOrderItemComponentAccessBean

        void setOrderItemComponentAccessBean(com.ibm.commerce.order.objects.OrderItemComponentAccessBean oICAB)
        Sets order item access bean which passed in.
        Parameters:
        oICAB - the order item access bean contains components in this dynamickit.
      • setQuantity

        void setQuantity(QuantityAmount quantity)
        Sets the quantity for command calculation
        Parameters:
        quantity - The reference numbers of a quantity to be used to determine the offers that will supply the prices and the adjustments to be applied to the prices.
      • setTradingIds

        void setTradingIds(java.lang.Long[] aTradingIds)
        Sets the ids of the input trading agreements (Optional).
        Parameters:
        aTradingIds - The reference numbers of a list of trading agreements to be used to determine the offers that will supply the prices and the adjustments to be applied to the prices.