Package com.broadleafcommerce.search.provider.solr.util

Enum Class SolrCommonCatalogFields

java.lang.Object
java.lang.Enum<SolrCommonCatalogFields>
com.broadleafcommerce.search.provider.solr.util.SolrCommonCatalogFields
All Implemented Interfaces:
Serializable, Comparable<SolrCommonCatalogFields>, Constable
public enum SolrCommonCatalogFields extends Enum<SolrCommonCatalogFields>
Enumeration of statically defined fields that might not be administered via the admin console. These are catalog-specifc, but common to both search and indexing. These are fields that are added by indexer components and/or filtered by search components that are not necessarily user defined.
Author:
Kelly Tisdell (ktisdell)

  • Enum Constant Details

    • ID

      public static final SolrCommonCatalogFields ID
      Constant indicating an ID field.

    • INVENTORY_CHECK_REQUIRED

      public static final SolrCommonCatalogFields INVENTORY_CHECK_REQUIRED
      Indicates if an inventory check is required for the Product being searched.

    • INVENTORY_AVAILABLE_FOR_TENANT_SCOPE

      public static final SolrCommonCatalogFields INVENTORY_AVAILABLE_FOR_TENANT_SCOPE
      Indicates if availability exists for this tenant (exclusive of application scoped availability).

    • INVENTORY_AVAILABLE_FOR_APPLICATION_SCOPES

      public static final SolrCommonCatalogFields INVENTORY_AVAILABLE_FOR_APPLICATION_SCOPES
      Indicates the application IDs for which there is available inventory.

    • ALL_SKUS

      public static final SolrCommonCatalogFields ALL_SKUS
      All of the SKUs for a given Product.

    • PRODUCT_CATEGORY_SORT

      public static final SolrCommonCatalogFields PRODUCT_CATEGORY_SORT
      A dynamic string field. Note that this must be used with String.format(String, Object...) to replace the wildcard with a category ID to complete the field name. This is generally used for sorting within a category.

    • VENDOR_REF

      public static final SolrCommonCatalogFields VENDOR_REF
      Soft reference to the vendor associated with the Product's catalog.

    • OPTION_LABEL

      public static final SolrCommonCatalogFields OPTION_LABEL
      The product option label

    • OPTION_NAME

      public static final SolrCommonCatalogFields OPTION_NAME
      The product option name

    • OPTION_VALUE

      public static final SolrCommonCatalogFields OPTION_VALUE
      The product option value

    • AVAILABLE_ONLINE

      public static final SolrCommonCatalogFields AVAILABLE_ONLINE
      Is this product available online?

  • Method Details

    • values

      public static SolrCommonCatalogFields[] 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 SolrCommonCatalogFields 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 String field()
      Get the typed name of the field for Solr.
      Returns:
      The typed name of the field for Solr