com.ibm.commerce.price.rule.commands.element

Interface PriceEquationCalculationCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
    All Known Implementing Classes:
    PriceEquationCalculationCmdImpl

    public interface PriceEquationCalculationCmd
extends com.ibm.websphere.command.CacheableCommand
    The interface for the price equation calculation command. There are two types of price equation according to the unit of its result value. One is number which represents a numerical value. The other is currency which represents a price. This interface can be used in two ways:
  • If you just want to calculate the resulting unit of the price equation and don't care about its real value, set the flag to TRUE by calling setFlag(true).
  • If you want to calculate the resulting unit of the price equation and its real value, set the flag to FALSE by calling setFlag(false).

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.
      static java.lang.String defaultCommandClassName
      Default implementation class for this command.
      static java.lang.String NAME
      The name of this command.

      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.price.rule.runtime.objects.PriceEquationResultObject getPriceEquationResultObject()
      Get the result object of price equation calculation.
      void setCatEntryId(java.lang.String aCatEntryId)
      Set the catalog entry ID.
      void setCurrency(java.lang.String aCurrency)
      Set the currency.
      void setEquationExpression(java.lang.String aExpression)
      Set the representing expression of price equation.
      void setFlag(boolean getUnitOnly)
      Set the flag of getUnitOnly.
      void setInputPrice(java.math.BigDecimal aInputPrice)
      Set the input price.
      void setQuantity(java.lang.Double aQuantity)
      Set the quantity.
      void setRuntimeParameters(java.util.Map runtimeParameters)
      Set the runtime parameters from the price rule engine.
      void setStoreId(java.lang.Integer aStoreId)
      Set the store ID.
      void setUom(java.lang.String aUom)
      Set the unit of measurement for the catalog entry.

      • Methods inherited from interface com.ibm.websphere.command.CacheableCommand

        executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

      • Methods inherited from interface com.ibm.websphere.command.TargetableCommand

        getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

      • Methods inherited from interface com.ibm.websphere.command.Command

        execute, isReadyToCallExecute, reset

      • Methods inherited from interface com.ibm.websphere.command.CommandCaller

        unionDependencies

    • 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
        Default implementation class for this command.
        See Also:
        Constant Field Values

    • Method Detail

      • setInputPrice

        void setInputPrice(java.math.BigDecimal aInputPrice)
        Set the input price.
        Parameters:
        aInputPrice -

      • setEquationExpression

        void setEquationExpression(java.lang.String aExpression)
        Set the representing expression of price equation.
        Parameters:
        aExpression -

      • setCatEntryId

        void setCatEntryId(java.lang.String aCatEntryId)
        Set the catalog entry ID.
        Parameters:
        aCatEntryId -

      • setCurrency

        void setCurrency(java.lang.String aCurrency)
        Set the currency.
        Parameters:
        aCurrency -

      • setStoreId

        void setStoreId(java.lang.Integer aStoreId)
        Set the store ID.
        Parameters:
        aStoreId -

      • setUom

        void setUom(java.lang.String aUom)
        Set the unit of measurement for the catalog entry.
        Parameters:
        aUom -

      • setQuantity

        void setQuantity(java.lang.Double aQuantity)
        Set the quantity.
        Parameters:
        aQuantity -

      • setFlag

        void setFlag(boolean getUnitOnly)
        Set the flag of getUnitOnly. Set true if only retrieve the unit of the value. Set false if retrieve both the value and the unit.
        Parameters:
        getUnitOnly -

      • setRuntimeParameters

        void setRuntimeParameters(java.util.Map runtimeParameters)
        Set the runtime parameters from the price rule engine.
        Parameters:
        runtimeParameters - The runtime parameters for price rule.

      • getPriceEquationResultObject

        com.ibm.commerce.price.rule.runtime.objects.PriceEquationResultObject getPriceEquationResultObject()
        Get the result object of price equation calculation.
        Returns:
        The price equation result object.