Package com.broadleafcommerce.pricing.domain.type

Enum Class PriceableFieldType

java.lang.Object
java.lang.Enum<PriceableFieldType>
com.broadleafcommerce.pricing.domain.type.PriceableFieldType
All Implemented Interfaces:
Serializable, Comparable<PriceableFieldType>, Constable
public enum PriceableFieldType extends Enum<PriceableFieldType> implements Comparable<PriceableFieldType>
Fields on PriceableTargets that the pricing service cares about.
Author:
Nathan Moore (nathanmoore).

  • Enum Constant Details

    • BASE_COST

      public static final PriceableFieldType BASE_COST
      Base cost of manufacturing the target provided by the target itself rather than being derived by the pricing service. Refers to the direct cost passed in from the product or the cost as provided by a COST price list type.

    • BASE_PRICE

      public static final PriceableFieldType BASE_PRICE
      Base price to sell the target at provided by the target itself rather than being derived by the pricing service.

    • STANDARD_PRICE

      public static final PriceableFieldType STANDARD_PRICE
      Price from a standard price list

    • SALE_PRICE

      public static final PriceableFieldType SALE_PRICE
      Price from a sale price list

    • STANDARD_AND_SALE_PRICE

      public static final PriceableFieldType STANDARD_AND_SALE_PRICE
      Only valid for an adjustment context. Indicates a modification applies to both the standard and sale prices.

    • CONTRACT_PRICE

      public static final PriceableFieldType CONTRACT_PRICE
      Price from a contract price list

    • ALL

      public static final PriceableFieldType ALL
      Only valid in an adjustment context. Indicates the adjustment applies to all pricing phases (e.g. STANDARD, SALE, and CONTRACT). Note: this would not apply to the COST phase which is not adjustable out of the box.

  • Method Details

    • values

      public static PriceableFieldType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static PriceableFieldType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • field

      public final String field()

    • order

      public final int order()

    • valuesOrdered

      public static List<PriceableFieldType> valuesOrdered()
      Returns an ordered list of all fields, excluding base cost.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<PriceableFieldType>