Enum Class ResultType

java.lang.Object
java.lang.Enum<ResultType>
org.broadleafcommerce.common.extension.ResultType
All Implemented Interfaces:
Serializable, Comparable<ResultType>, Constable

public enum ResultType extends Enum<ResultType>
Used in conjunction with SparselyPopulatedQueryExtensionHandler. Describes the current type of results desired from a query. STANDARD results relate specifically to a standard site (multitenant concept). TEMPLATE results relate specifically to a template site's catalog or profile (also a multitenant concept)
Author:
Jeff Fischer
  • Enum Constant Details

    • STANDARD

      public static final ResultType STANDARD
    • STANDARD_CACHE

      public static final ResultType STANDARD_CACHE
    • TEMPLATE

      public static final ResultType TEMPLATE
    • TEMPLATE_CACHE

      public static final ResultType TEMPLATE_CACHE
    • IGNORE

      public static final ResultType IGNORE
    • CATALOG_ONLY

      public static final ResultType CATALOG_ONLY
  • Method Details

    • values

      public static ResultType[] 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 ResultType 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