Index (Broadleaf Search Services Search API Library 2.1.1-GA API)

A B C D E F G H I L M N P R S T V W
All Classes and Interfaces|All Packages|Serialized Form

A

abbreviation(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
add(String) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: Adds a word to the suggestion list.
addAll(List<String>) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: Adds a list of words to the suggestion list.
addFieldType(String, String) - Method in class com.broadleafcommerce.search.api.service.MapFieldTypeConverter: Adds a supported field type.
addOccurrence(int, int) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: Adds an additional occurrence of this term in the search query.
addQuerySuggestion(String, long) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: Add a suggested query replacement.
addSpellSuggestion(String, List<String>, int, int) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: Add a new spell check suggestion to the results.
ADMIN - Enum constant in enum class com.broadleafcommerce.search.api.type.DefaultSettingsContextType
afterPropertiesSet() - Method in class com.broadleafcommerce.search.api.type.autoconfigure.IndexableTypeInitializer
Archiveable - Interface in com.broadleafcommerce.search.api.domain: Interface for objects which can be archived.
attributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Miscellaneous attributes for this field.

B

BOOLEAN - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
BOOLEANS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
build() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder
builder() - Static method in class com.broadleafcommerce.search.api.domain.FieldDefinition

C

canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.Facet
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetRange
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetResponse
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetValue
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldQuery
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldRef
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldVariant
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.Filter
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.RuleFilter
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SortGroup
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SortOption
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SortResponse
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.SuggestionField
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.Suggestion
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
canEqual(Object) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration
canEqual(Object) - Method in class com.broadleafcommerce.search.api.type.FieldType
canEqual(Object) - Method in class com.broadleafcommerce.search.api.type.IndexableType
canEqual(Object) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties
canParticipate() - Method in interface com.broadleafcommerce.search.api.DistributedLock: Indicates if the current thread, JVM, or environment can use this lock.
CATALOG - Enum constant in enum class com.broadleafcommerce.search.api.domain.accesspolicy.DefaultCatalogAccessPolicyTargetType: Restricts access to the entire targeted catalog(s)
CatalogTrackable - Interface in com.broadleafcommerce.search.api.domain: Interface for objects which are trackable by catalog.
com.broadleafcommerce.search.api - package com.broadleafcommerce.search.api
com.broadleafcommerce.search.api.domain - package com.broadleafcommerce.search.api.domain
com.broadleafcommerce.search.api.domain.accesspolicy - package com.broadleafcommerce.search.api.domain.accesspolicy
com.broadleafcommerce.search.api.domain.translation - package com.broadleafcommerce.search.api.domain.translation
com.broadleafcommerce.search.api.domain.typeahead - package com.broadleafcommerce.search.api.domain.typeahead
com.broadleafcommerce.search.api.service - package com.broadleafcommerce.search.api.service
com.broadleafcommerce.search.api.type - package com.broadleafcommerce.search.api.type
com.broadleafcommerce.search.api.type.annotations - package com.broadleafcommerce.search.api.type.annotations
com.broadleafcommerce.search.api.type.autoconfigure - package com.broadleafcommerce.search.api.type.autoconfigure
com.broadleafcommerce.search.autoconfigure - package com.broadleafcommerce.search.autoconfigure
com.broadleafcommerce.search.provider - package com.broadleafcommerce.search.provider
com.broadleafcommerce.search.util - package com.broadleafcommerce.search.util
combined(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Whether or not this field should be a combination of multiple path values.
conversions - Variable in class com.broadleafcommerce.search.api.service.MapFieldTypeConverter: A bi-directional map to store conversions from generic field types to search-engine-specific implementation field types, and vice versa.
convert(IndexableType) - Method in class com.broadleafcommerce.search.api.type.IndexableConverter.ConvertToString
convert(IndexableType) - Method in class com.broadleafcommerce.search.api.type.IndexableType.IndexableTypeConverter
convert(String) - Method in class com.broadleafcommerce.search.api.type.IndexableConverter.ConvertFromString
convertFieldType(String) - Method in interface com.broadleafcommerce.search.api.service.FieldTypeConverter: Convert a generic field type to an implementation specific type.
convertFieldType(String) - Method in class com.broadleafcommerce.search.api.service.MapFieldTypeConverter
convertFromString() - Method in class com.broadleafcommerce.search.api.type.autoconfigure.IndexableTypeAutoConfiguration
ConvertFromString() - Constructor for class com.broadleafcommerce.search.api.type.IndexableConverter.ConvertFromString
convertToString() - Method in class com.broadleafcommerce.search.api.type.autoconfigure.IndexableTypeAutoConfiguration
ConvertToString() - Constructor for class com.broadleafcommerce.search.api.type.IndexableConverter.ConvertToString
CURRENCY - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
currentThreadHoldsLock() - Method in interface com.broadleafcommerce.search.api.DistributedLock: Indicates if the current thread holds the lock.

D

DATE - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
DATES - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
DefaultCatalogAccessPolicyTargetType - Enum Class in com.broadleafcommerce.search.api.domain.accesspolicy: Enumeration for SearchCatalogAccessPolicy.getTargetType().
DefaultFieldType - Class in com.broadleafcommerce.search.api.type: Generic FieldTypes provided by default.
DefaultFieldType(String) - Constructor for class com.broadleafcommerce.search.api.type.DefaultFieldType
DefaultSettingsContextType - Enum Class in com.broadleafcommerce.search.api.type: Defines the default contexts for SearchSettings.
deleteByField(String, String, int, String...) - Method in interface com.broadleafcommerce.search.provider.ReindexProvider: Perform a delete operation, deleting by a field name and value.
delimiter(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: If this is a combined field, this is the delimiter string which should separate the values found from the propertyPaths.
DistributedLock - Interface in com.broadleafcommerce.search.api: Interface to indicate a distributed lock, or one that can be shared across JVMs.
DistributedLockException - Exception in com.broadleafcommerce.search.api: RuntimeException to identify that there was an issue obtaining or otherwise releasing a distributed lock.
DistributedLockException() - Constructor for exception com.broadleafcommerce.search.api.DistributedLockException
DistributedLockException(String) - Constructor for exception com.broadleafcommerce.search.api.DistributedLockException
DistributedLockException(String, Throwable) - Constructor for exception com.broadleafcommerce.search.api.DistributedLockException
DistributedLockException(String, Throwable, boolean, boolean) - Constructor for exception com.broadleafcommerce.search.api.DistributedLockException
DistributedLockException(Throwable) - Constructor for exception com.broadleafcommerce.search.api.DistributedLockException
DOUBLE - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
DOUBLES - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType

E

EMAIL - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
EMAILS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.Facet
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetRange
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetResponse
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FacetValue
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldQuery
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldRef
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FieldVariant
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.Filter
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.RuleFilter
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SortGroup
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SortOption
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SortResponse
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.SuggestionField
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.Suggestion
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
equals(Object) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration
equals(Object) - Method in class com.broadleafcommerce.search.api.type.FieldType
equals(Object) - Method in class com.broadleafcommerce.search.api.type.IndexableType
equals(Object) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties
execute() - Method in interface com.broadleafcommerce.search.util.GenericOperation: Provides a mechanism to simply execute a block of code, generically.
executeRetryableOperation(GenericOperation<R>) - Static method in class com.broadleafcommerce.search.util.RetryableOperationUtil: Executes the provided operation up to 5 times if there are exceptions, waiting an additive 100 ms between tries.
executeRetryableOperation(GenericOperation<R>, int, long, boolean, Class<? extends Exception>...) - Static method in class com.broadleafcommerce.search.util.RetryableOperationUtil: Executes the provided operation up to as many times as the retries argument.
executeRetryableOperation(GenericOperation<R>, Class<? extends Exception>...) - Static method in class com.broadleafcommerce.search.util.RetryableOperationUtil: Executes the provided operation up to 5 times if there are exceptions, waiting an additive 100 ms between tries.

F

facet(Facet) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The facet which is driven by this field.
Facet - Class in com.broadleafcommerce.search.api.domain: This represents an available search facet and its filtering options.
Facet() - Constructor for class com.broadleafcommerce.search.api.domain.Facet
faceted(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Indicates if this field has a facet.
FacetGroup - Class in com.broadleafcommerce.search.api.domain: Provides a way to group related Facets to easily reuse them in different contexts.
FacetGroup() - Constructor for class com.broadleafcommerce.search.api.domain.FacetGroup
FacetGroupFacet - Class in com.broadleafcommerce.search.api.domain: Represents a link between a FacetGroup and a Facet.
FacetGroupFacet() - Constructor for class com.broadleafcommerce.search.api.domain.FacetGroupFacet
FacetRange - Class in com.broadleafcommerce.search.api.domain: Represents a selectable option of a search facet.
FacetRange() - Constructor for class com.broadleafcommerce.search.api.domain.FacetRange
FacetResponse - Class in com.broadleafcommerce.search.api.domain: Represents a search facet and its results from a search response.
FacetResponse() - Constructor for class com.broadleafcommerce.search.api.domain.FacetResponse
FacetValue - Class in com.broadleafcommerce.search.api.domain: Class representing the actual facet results returned from the search engine.
FacetValue() - Constructor for class com.broadleafcommerce.search.api.domain.FacetValue
facetVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The field variant type which should be faceted on.
FieldDefinition - Class in com.broadleafcommerce.search.api.domain: A field which can be indexed and searched by.
FieldDefinition() - Constructor for class com.broadleafcommerce.search.api.domain.FieldDefinition
FieldDefinition(String, String, String, boolean, String, boolean, String, List<String>, String, String, boolean, List<FieldVariant>, boolean, Facet, String, boolean, SortOption, String, boolean, List<FieldQuery>, Map<String, FieldVariant>, Map<String, Object>) - Constructor for class com.broadleafcommerce.search.api.domain.FieldDefinition
FieldDefinition.FieldDefinitionBuilder - Class in com.broadleafcommerce.search.api.domain
fieldQueries(List<FieldQuery>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Defines how this field should be queried by variants on particular query types.
FieldQuery - Class in com.broadleafcommerce.search.api.domain: Associates a FieldVariant for a field to make it searchable based on a particular query type.
FieldQuery() - Constructor for class com.broadleafcommerce.search.api.domain.FieldQuery
FieldRef - Class in com.broadleafcommerce.search.api.domain: DTO for holding field definition data.
FieldRef() - Constructor for class com.broadleafcommerce.search.api.domain.FieldRef
FieldType - Class in com.broadleafcommerce.search.api.type: A generic representation for the type of a field.
FieldType(String) - Constructor for class com.broadleafcommerce.search.api.type.FieldType
FieldType(String, boolean) - Constructor for class com.broadleafcommerce.search.api.type.FieldType
FieldTypeConverter - Interface in com.broadleafcommerce.search.api.service: Defines interface to convert a general field type to an implementation specific type.
FieldVariant - Class in com.broadleafcommerce.search.api.domain: A specific variant of a field representing the concrete indexed version with a type.
FieldVariant() - Constructor for class com.broadleafcommerce.search.api.domain.FieldVariant
fieldVariantMap(Map<String, FieldVariant>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: A map of each field variant type to the corresponding FieldVariant.
Filter - Class in com.broadleafcommerce.search.api.domain
Filter() - Constructor for class com.broadleafcommerce.search.api.domain.Filter
FilterRangeValue - Class in com.broadleafcommerce.search.api.domain
FilterRangeValue() - Constructor for class com.broadleafcommerce.search.api.domain.FilterRangeValue
fromString(String) - Static method in class com.broadleafcommerce.search.api.type.IndexableType

G

GenericOperation<R> - Interface in com.broadleafcommerce.search.util: Functional interface that provides a method to execute code generically.
getAbbreviation() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
getAbbreviation() - Method in class com.broadleafcommerce.search.api.domain.FieldRef: Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
getAccountHierarchy() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The hierarchy of accounts, from the root account to the account member's account.
getAccountId() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The ID of the account the user belongs to.
getActiveEndDate() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: The date until which the policy should be active.
getActiveStartDate() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: The date from which the policy should be active.
getAdditionalClaims() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties: Represents a list of additional auth token claims to add as attributes to the SearchCatalogAccessPolicyContext for rules to be evaluated against.
getAllIndexableTypes() - Static method in class com.broadleafcommerce.search.api.type.IndexableType: Get all of the existing indexable types.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: Additional, arbitrary request attributes.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.Facet: Miscellaneous attributes for this facet.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: Miscellaneous attributes for this facet group.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Miscellaneous attributes for this field.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: Miscellaneous attributes for this search settings.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.SortGroup: Miscellaneous attributes for this sort group.
getAttributes() - Method in class com.broadleafcommerce.search.api.domain.SortOption: Miscellaneous attributes for this sort option.
getAutocompleteSuggestionLimit() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The number of autocomplete suggestions to return on a TypeAhead search.
getAutoCorrectQuery() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: Optional.
getBehaviors() - Method in class com.broadleafcommerce.search.api.type.IndexableType: The trackable behaviors which apply to objects of this indexable type.
getBoost() - Method in class com.broadleafcommerce.search.api.domain.FieldQuery: The amount to boost this variant for this query type.
getCatalogOmissions() - Method in interface com.broadleafcommerce.search.api.domain.CatalogTrackable: The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.
getCatalogOverrides() - Method in interface com.broadleafcommerce.search.api.domain.CatalogTrackable: Get any catalog contexts where this trackable has been overridden.
getCategoryProductMembershipFilters() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The rule-based RSQL filters used to check if a related product is a member of the specified category.
getChildren() - Method in class com.broadleafcommerce.search.api.type.IndexableType: Returns a set of IndexableType instances that have this instance as a parent.
getConfig() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: The configuration to use on this TypeAhead query.
getConfigName() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The name of this configuration.
getContent() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getContextState() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.Facet: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.SortGroup: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.SortOption: A subset of Tracking information to expose the context state for this object.
getContextState() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: A subset of Tracking information to expose the context state for this object.
getConvertedContent(Function<? super Object, ? extends U>) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getCustomerSegmentIds() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The list of ids that correspond to customer segments that this customer is a part of.
getDebug() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse: The raw query response for debugging purposes.
getDelimiter() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: If this is a combined field, this is the delimiter string which should separate the values found from the propertyPaths.
getDisplayOrder() - Method in class com.broadleafcommerce.search.api.domain.Facet: Order in which to display this facet on a list of facets.
getDisplayOrder() - Method in class com.broadleafcommerce.search.api.domain.FacetRange: Order in which to display this range on a list of facet ranges.
getDisplayOrder() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: The display order for this facet value.
getDisplayOrder() - Method in class com.broadleafcommerce.search.api.domain.SortOption: The display order of this sort option
getEmail() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's email.
getEnableSpellCheck() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: Optional.
getEndOffset() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
getEntityField() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The name of the field on the entity to which this translation applies.
getEntityId() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The ID of the entity to which this translation applies.
getEntityType() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The type of the entity to which this translation applies, e.g., PRODUCT, CATEGORY, OFFER.
getFacet() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: The facet in this relationship.
getFacet() - Method in class com.broadleafcommerce.search.api.domain.FacetResponse: The facet which was determined in the search.
getFacet() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The facet which is driven by this field.
getFacetGroup() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: The facet group in this relationship
getFacetGroup() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: The facet group in this relationship
getFacetGroups() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The facet groups managed on this search settings.
getFacetRule() - Method in class com.broadleafcommerce.search.api.domain.Facet: The rule required to be met for this facet to be active.
getFacets() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The facets in this facet group.
getFacets() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: The facets returned in the search result.
getFacetVariant() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Retrieve the FieldVariant to be used for faceting.
getFacetVariantType() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The field variant type which should be faceted on.
getField() - Method in class com.broadleafcommerce.search.api.domain.Facet: The FieldRef this facet belongs to.
getField() - Method in class com.broadleafcommerce.search.api.domain.FieldVariant: The field which this variant represents.
getField() - Method in class com.broadleafcommerce.search.api.domain.SortOption: The field to be sorted on.
getFieldDefinition() - Method in class com.broadleafcommerce.search.api.domain.SuggestionField: The field definition to provide suggestions for.
getFieldDefinitionId() - Method in class com.broadleafcommerce.search.api.domain.Facet
getFieldDefinitionId() - Method in class com.broadleafcommerce.search.api.domain.SortOption
getFieldIndexableType() - Method in class com.broadleafcommerce.search.api.domain.Facet
getFieldIndexableType() - Method in class com.broadleafcommerce.search.api.domain.SortOption
getFieldQueries() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Defines how this field should be queried by variants on particular query types.
getFieldVariant() - Method in class com.broadleafcommerce.search.api.domain.SuggestionField: Retrieves the FieldVariant to be used for this suggestion field.
getFieldVariantMap() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: A map of each field variant type to the corresponding FieldVariant.
getFilterRules() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Filters that should be applied to catalog requests.
getFilters() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The list of filters to apply to this query.
getFilters() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: The list of filters to apply to this query.
getFilterVariant() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Retrieve the FieldVariant to be used for filtering.
getFullName() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's full name.
getGroupIndexableType() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The indexable type of the fields for this facet group.
getGroupIndexableType() - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The indexable type of the fields for this facet group.
getHighlightAppend() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: When highlighting, this is a string that will be prepended to a matching keyword.
getHighlightedSuggestion() - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase: A suggested or phrase with highlighting applied.
getHighlightFields() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The fields to highlight.
getHighlightFragmentSize() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The approximate size, in characters, of fragments to consider for highlighting.
getHighlightPrepend() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: When highlighting, this is a string that will be prepended to a matching keyword.
getHits() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
getId() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Id for the policy.
getId() - Method in class com.broadleafcommerce.search.api.domain.Facet: The context ID of the facet.
getId() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The context ID of the facet group.
getId() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: The context ID of the facet group facet relationship.
getId() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The context ID of the field.
getId() - Method in class com.broadleafcommerce.search.api.domain.FieldRef: The context ID of the field.
getId() - Method in interface com.broadleafcommerce.search.api.domain.Indexable: Returns the identifier for this object.
getId() - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
getId() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The context ID of this search redirect.
getId() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The context ID of the search settings.
getId() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: The context ID of the settings facet group relationship.
getId() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: The context ID of the settings sort group relationship.
getId() - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The context ID of the sort group.
getId() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: The context ID of the sort group sort option xref.
getId() - Method in class com.broadleafcommerce.search.api.domain.SortOption: The context ID of the sort option.
getId() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The context ID of this Translation
getId() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
getIncorrectWord() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: The original word in the search query that is misspelled.
getIndexableType() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The type to which this field belongs.
getIndexableType() - Method in class com.broadleafcommerce.search.api.domain.FieldRef: The type to which this field belongs.
getIndexableType() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The IndexableType this configuration belongs to.
getInstance(String) - Static method in class com.broadleafcommerce.search.api.type.FieldType: Get the instance of FieldType for the given named type representation.
getInstance(String) - Static method in class com.broadleafcommerce.search.api.type.IndexableType: Retrieves an IndexableType based on its String representation.
getJsonMap() - Method in interface com.broadleafcommerce.search.api.domain.Indexable: The raw JSON map representing the Indexable object.
getJsonMap() - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
getJsonPath() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Retrieve the JSON path to the property holding this field on an indexable object, if present.
getJsonPaths() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: If this field is combined, retrieve the JSON path to the property holding the fields on an indexable object to be combined, if present.
getKeyWords() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse: The keywords associated with this response.
getLabel() - Method in class com.broadleafcommerce.search.api.domain.Facet: A value intended for display on a UI.
getLabel() - Method in class com.broadleafcommerce.search.api.domain.FacetRange: The label for this facet range, suitable for display.
getLabel() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The label of the field, suitable for display.
getLabel() - Method in class com.broadleafcommerce.search.api.domain.FieldRef: The label of the field, suitable for display.
getLabel() - Method in class com.broadleafcommerce.search.api.domain.SortOption: The label of this search option
getLabel() - Method in class com.broadleafcommerce.search.api.type.IndexableType: The label representation of the indexable type shown for administration.
getLocale() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The Locale wherein this Translation is applicable
getMarketplaceApplications() - Method in interface com.broadleafcommerce.search.api.domain.CatalogTrackable: All of the IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.
getMatchRule() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Match rule to evaluate against a context object containing user and request data.
getMaxValue() - Method in class com.broadleafcommerce.search.api.domain.FacetRange: The highest value included in this facet range.
getMaxValue() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: If ranged, the upper bound of values matching this facet value
getMaxValue() - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue: The maximum value to be applied on this filter.
getMinValue() - Method in class com.broadleafcommerce.search.api.domain.FacetRange: The lowest value included in this facet range.
getMinValue() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: If ranged, the lower bound of values matching this facet value
getMinValue() - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue: The minimum value to be applied on this filter value.
getMultiValuedCombinedPropertyRootPath() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: For fields which are both FieldDefinition.multiValued AND FieldDefinition.combined, this will be path to the list containing the objects representing each value.
getName() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Name of the policy.
getName() - Method in class com.broadleafcommerce.search.api.domain.Facet: Name to use to identify the facet.
getName() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The name of the facet group.
getName() - Method in class com.broadleafcommerce.search.api.domain.Filter: The name of the property to filter on, e.g.
getName() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: A name to describe the purpose of this search redirect.
getName() - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The name of the sort group.
getName() - Method in class com.broadleafcommerce.search.api.domain.SortOption: Name to use to identify the sort option.
getName() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: The name to be displayed in the results.
getNumber() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getNumberOfElements() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getOffsets() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: The offset positions of this string in the original query.
getOriginalQuery() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: The original search query.
getOverrideChangeContainer() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet
getOverrideChangeContainer() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
getOverrideChangeContainer() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup
getOverrideChangeContainer() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption
getOverrideLocale() - Method in class com.broadleafcommerce.search.api.domain.RuleFilter: The override locale to be used when evaluating the rule in the RSQLSolrQueryContributor.
getPageable() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getParent() - Method in class com.broadleafcommerce.search.api.type.IndexableType: Some of these enumerated types can have a parent or common type.
getPhoneNumber() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's phone number.
getPhraseSlop() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The phrase slop.
getPropertyPath() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The JSON path of this field excluding the root prefix, "$.".
getPropertyPaths() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: If this is a combined field, these are the JSON paths to the fields to be combined into the final value, excluding the root prefix, "$.".
getQuantity() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: The quantity of results matching this facet value
getQuery() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The raw search query.
getQuery() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
getQuery() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: The TypeAhead query.
getQueryMatch() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The value that a query must match to activate the redirect.
getQueryType() - Method in class com.broadleafcommerce.search.api.domain.FieldQuery: The query type which should be boosted on.
getRanges() - Method in class com.broadleafcommerce.search.api.domain.Facet: The different range options available for filtering on this search facet.
getRanges() - Method in class com.broadleafcommerce.search.api.domain.Filter: The ranged values of this filter.
getRedirect() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: A redirect generated based on the original request query.
getRedirectType() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The type of redirect which should be performed.
getRedirectType() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse: The HTTP status type of redirect which should be performed
getRedirectUri() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The URI which the client should be redirected to if the search query matches.
getRedirectUri() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse: The URI to which the client should be redirected.
getRequestAttributeList() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties: Represents the list of attribute from a WebRequest to store on SearchCatalogAccessPolicyContext.
getResultLimit() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: The maximum number of results to return for this configuration.
getRootAccountId() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The ID of the root account the account member belongs to.
getRule() - Method in class com.broadleafcommerce.search.api.domain.RuleFilter: Rule-based RSQL filters to be searched upon
getRuleFilters() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: Additional rule-based RSQL filters to apply to this query.
getRuleFilters() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: Additional rule-based RSQL filters to apply to this query.
getSandboxOverrides() - Method in interface com.broadleafcommerce.search.api.domain.SandboxTrackable: Get any sandbox contexts where this trackable has been overridden.
getSandboxOwner() - Method in interface com.broadleafcommerce.search.api.domain.SandboxTrackable: Get the owner of this object in the sandbox context.
getSearchSettings() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: The search settings in this relationship
getSearchSettings() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: The search settings in this relationship
getSettingsContext() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The scoped context of this SearchSettings.
getSize() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getSort() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
getSorted() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: Whether the persistent counterpart to this FacetGroupFacet has a non-default value for Sortable.getSorting(), which determines order in admin list grids.
getSorted() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: Whether the persistent counterpart to this SortGroupSortOption has a non-default value for Sortable.getSorting(), which determines order in admin list grids.
getSortGroup() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: The sort group in this relationship
getSortGroup() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: The sort group in this relationship.
getSortGroups() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The sort groups managed on this search settings.
getSorting() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: Field indicating a sort order, if sorted.
getSorting() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: Field indicating a sort order, if sorted.
getSortOption() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The sort option which is driven by this field.
getSortOption() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: The sort option in this relationship.
getSortOption() - Method in class com.broadleafcommerce.search.api.domain.SortResponse: The Sort Option information for this sort.
getSortOptions() - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The sort options in this sort group.
getSorts() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: The sort options returned in the search result.
getSortVariant() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Retrieve the FieldVariant to be used for sorting.
getSortVariantType() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The field variant type which should be sorted on.
getSpellCheckResult() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: Set if spellcheck returned any results.
getStartOffset() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
getSuggestedQueries() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: The suggested queries after spell correction, in order of most to least recommended.
getSuggestion() - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase: A suggested word or phrase.
getSuggestionFields() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: The list of fields to be returned with this suggestion.
getSuggestionMap() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: Suggested spelling corrections of the original query to retrieve results.
getSuggestions() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: Get all of the spell check suggestions.
getSuggestions() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: The suggested terms to replace the corrected word, ordered by recommendation.
getSuggestions() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse: A map of suggestions, with the key being the name of the origin of the suggestion.
getTargetCatalogIds() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: List of the target Catalog.getId() that this catalog access policy applies to.
getTargetType() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: The target type denoting how to restrict this catalog access policy.
getTerm() - Method in class com.broadleafcommerce.search.api.domain.typeahead.Suggestion: The suggested term.
getTopLevelAncestor() - Method in class com.broadleafcommerce.search.api.type.IndexableType: Recursively finds the highest level ancestor for this IndexableType.
getTopSuggestionQuery() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: Get the best suggested query based on the number of hits.
getTrackableBehaviorPackage() - Method in class com.broadleafcommerce.search.api.type.IndexableType: Produce a TrackableBehaviorPackage for the behaviors on this indexable type.
getTranslations() - Method in interface com.broadleafcommerce.search.api.domain.Indexable: Any translations present for this Indexable object.
getTranslations() - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
getType() - Method in class com.broadleafcommerce.search.api.domain.FieldVariant: The general type of value stored in this field.
getType() - Method in interface com.broadleafcommerce.search.api.domain.Indexable: Provides a type or "namespace" for documents that are co-mingled in an index.
getType() - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
getType() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The IndexableType for this query.
getType() - Method in class com.broadleafcommerce.search.api.type.FieldType: The named representation of the type.
getType() - Method in class com.broadleafcommerce.search.api.type.IndexableType: The named representation of the indexable type.
getTypeAheadSuggestionConfigurations() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: Configurations defining what should be returned on a TypeAhead query.
getTypeHint() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The type hint for this translation.
getUserId() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's id.
getUsername() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's username.
getValue() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: The value label for this facet value.
getValue() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: This field holds the actual translated value.
getValues() - Method in class com.broadleafcommerce.search.api.domain.FacetResponse: The values returned from search for this facet.
getValues() - Method in class com.broadleafcommerce.search.api.domain.Filter: The values of the filter.
getVariantMap() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Returns a lazily initialized map of each field variant type to the corresponding FieldVariant.
getVariants() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The specific typed variants for this field.
getVariantType() - Method in class com.broadleafcommerce.search.api.domain.Facet: The field variant type which should be faceted on.
getVariantType() - Method in class com.broadleafcommerce.search.api.domain.FieldQuery: The field variant type which should be boosted on.
getVariantType() - Method in class com.broadleafcommerce.search.api.domain.SortOption: The field variant type which should be sorted on.
getVariantType() - Method in class com.broadleafcommerce.search.api.domain.SuggestionField: The variant type to use when building suggestions.
getWhitelistedServiceCallers() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties: The names of external microservices that are expected to call Search Service for admin or bulk processing requests and should be whitelisted so that they bypass Catalog Access Policy filtering.
GLOBAL_ENV_CAN_OBTAIN_LOCK_PROPERTY_NAME - Static variable in interface com.broadleafcommerce.search.api.DistributedLock: Default property name to determine, globally, whether this environment (JVM) can obtain a lock of this type.

H

hasContent() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
hashCode() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy
hashCode() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext
hashCode() - Method in class com.broadleafcommerce.search.api.domain.Facet
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FacetRange
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FacetResponse
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FacetValue
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FieldQuery
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FieldRef
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FieldVariant
hashCode() - Method in class com.broadleafcommerce.search.api.domain.Filter
hashCode() - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue
hashCode() - Method in class com.broadleafcommerce.search.api.domain.RuleFilter
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SortGroup
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SortOption
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SortResponse
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
hashCode() - Method in class com.broadleafcommerce.search.api.domain.SuggestionField
hashCode() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation
hashCode() - Method in class com.broadleafcommerce.search.api.domain.typeahead.Suggestion
hashCode() - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase
hashCode() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest
hashCode() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse
hashCode() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
hashCode() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration
hashCode() - Method in class com.broadleafcommerce.search.api.type.FieldType
hashCode() - Method in class com.broadleafcommerce.search.api.type.IndexableType
hashCode() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties
hasPrevious() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
hasTrackableBehavior(TrackableBehavior) - Method in class com.broadleafcommerce.search.api.type.IndexableType: Check whether or not objects of this indexable type exhibit the given TrackableBehavior.

I

id(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The context ID of the field.
Indexable<ID> - Interface in com.broadleafcommerce.search.api.domain: Interface for anything that can be indexed for search.
IndexableConverter - Class in com.broadleafcommerce.search.api.type: Handles conversions between concrete IndexableType and Strings.
IndexableConverter() - Constructor for class com.broadleafcommerce.search.api.type.IndexableConverter
IndexableConverter.ConvertFromString - Class in com.broadleafcommerce.search.api.type
IndexableConverter.ConvertToString - Class in com.broadleafcommerce.search.api.type
IndexableInitializationException - Exception in com.broadleafcommerce.search.api.type: Exception thrown when there's an issue initializing an IndexableType.
IndexableInitializationException(String, Exception) - Constructor for exception com.broadleafcommerce.search.api.type.IndexableInitializationException: Constructs a new runtime exception with the specified detail message and cause.
indexableType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The type to which this field belongs.
IndexableType - Class in com.broadleafcommerce.search.api.type: Extensible enumeration specifying the type of Indexable being indexed (e.g.
IndexableType(String, boolean, TrackableBehavior...) - Constructor for class com.broadleafcommerce.search.api.type.IndexableType: Constructs an IndexableType from a String.
IndexableType(String, String, boolean, boolean, TrackableBehavior...) - Constructor for class com.broadleafcommerce.search.api.type.IndexableType: Constructs an IndexableType from a String with a label.
IndexableType(String, String, boolean, TrackableBehavior...) - Constructor for class com.broadleafcommerce.search.api.type.IndexableType: Constructs an IndexableType from a String with a label.
IndexableType(String, String, IndexableType, boolean, boolean, TrackableBehavior...) - Constructor for class com.broadleafcommerce.search.api.type.IndexableType: Constructs an instance of IndexableType with a parent.
IndexableType.IndexableTypeConverter - Class in com.broadleafcommerce.search.api.type
IndexableTypeAutoConfiguration - Class in com.broadleafcommerce.search.api.type.autoconfigure: Configuration responsible for picking up IndexableType classes to ensure they are properly initialized and usable.
IndexableTypeAutoConfiguration() - Constructor for class com.broadleafcommerce.search.api.type.autoconfigure.IndexableTypeAutoConfiguration
IndexableTypeConverter() - Constructor for class com.broadleafcommerce.search.api.type.IndexableType.IndexableTypeConverter
indexableTypeInitializer(ApplicationContext) - Method in class com.broadleafcommerce.search.api.type.autoconfigure.IndexableTypeAutoConfiguration
IndexableTypeInitializer - Class in com.broadleafcommerce.search.api.type.autoconfigure: Initializer responsible for picking up IndexableType classes to ensure they are properly initialized and usable.
IndexableTypeInitializer(ApplicationContext) - Constructor for class com.broadleafcommerce.search.api.type.autoconfigure.IndexableTypeInitializer
IndexableTypes - Annotation Interface in com.broadleafcommerce.search.api.type.annotations: Annotation to be used on Spring configuration classes to ensure an IndexableType is initialized.
INTEGER - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
INTEGERS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
InvalidSearchException - Exception in com.broadleafcommerce.search.api
InvalidSearchException() - Constructor for exception com.broadleafcommerce.search.api.InvalidSearchException
InvalidSearchException(String) - Constructor for exception com.broadleafcommerce.search.api.InvalidSearchException
InvalidSearchException(String, Throwable) - Constructor for exception com.broadleafcommerce.search.api.InvalidSearchException
InvalidSearchException(String, Throwable, boolean, boolean) - Constructor for exception com.broadleafcommerce.search.api.InvalidSearchException
InvalidSearchException(Throwable) - Constructor for exception com.broadleafcommerce.search.api.InvalidSearchException
isActive() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: Whether or not this facet value was active on the search
isActive() - Method in class com.broadleafcommerce.search.api.domain.SortResponse: Whether or not this sort is active.
isArchived() - Method in interface com.broadleafcommerce.search.api.domain.Archiveable: Whether or not this object is archived.
isCombined() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Whether or not this field should be a combination of multiple path values.
isCorrectedQuery() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: If no results were found and a different query was executed than the original, this is set to true.
isDebug() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: If set to true, a string containing debug information about the query results will be returned.
isDebug() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: If set to true, a string containing debug information about the query results will be returned.
isDescending() - Method in class com.broadleafcommerce.search.api.domain.SortResponse: Whether the sort should be descending.
isEnabled() - Method in class com.broadleafcommerce.search.autoconfigure.SearchSettingsProperties: Whether SearchSettings features will be used.
isFaceted() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Indicates if this field has a facet.
isFaceted() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: Is this configuration faceted? Required for showing a result count.
isFirst() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
isIncludeInResponse() - Method in class com.broadleafcommerce.search.api.domain.FieldVariant: Determines whether or not this variant should be included in the search response.
isIndexCountrySpecificLanguageDialects() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties: Whether to index language dialects identified by country and language, or just the language.
isIndexLanguagesForTenantDefaultLocale() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties: Whether or not to index the tenant's default locale.
isMultiSelect() - Method in class com.broadleafcommerce.search.api.domain.Facet: Determines whether or not this facet allows multiple values to be selected.
isMultiValued() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Whether or not this field should contain a list of values.
isMultiValued() - Method in class com.broadleafcommerce.search.api.type.FieldType: Whether this type supports multiple values.
isNotFound() - Method in interface com.broadleafcommerce.search.api.domain.Indexable: Returns true if the item was not found when querying the service, otherwise false.
isNotFound() - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
isRanged() - Method in class com.broadleafcommerce.search.api.domain.Facet: Designates whether or not this facet is ranged.
isRanged() - Method in class com.broadleafcommerce.search.api.domain.FacetValue: Whether or not this value is a range.
isRangedFilter() - Method in class com.broadleafcommerce.search.api.domain.Filter: Determines whether or not this is a ranged query.
isRegex() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: Whether or not the queryMatch should be applied as a Regex.
isRegistered() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: Defines whether the user is registered.
isRuledFacet() - Method in class com.broadleafcommerce.search.api.domain.Facet
isSearchable() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Whether or not the search query should be applied to this field on search.
isSearchEnabled() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: Whether advanced search is enabled.
isSortable() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Indicates if this field is sortable.
isSpellCheckedQuery() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: This is set to true if this query has already been run once to avoid unnecessarily spellchecking the query a second time.
isTranslatable() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Indicates if this field is translatable.
isTranslatable() - Method in class com.broadleafcommerce.search.api.domain.FieldRef: Indicates if this field is translatable.
isTranslatable() - Method in class com.broadleafcommerce.search.api.type.IndexableType: Whether or not objects of this indexable type are translatable.
isVendorBehavior() - Method in class com.broadleafcommerce.search.api.type.IndexableType: Whether or not objects of this indexable type can be discriminated by vendor
iterator() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse

L

label(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The label of the field, suitable for display.
LOCATION - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
LONG - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
LONGS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType

M

MapFieldTypeConverter - Class in com.broadleafcommerce.search.api.service: A FieldTypeConverter which stores the field type conversions in a map.
MapFieldTypeConverter() - Constructor for class com.broadleafcommerce.search.api.service.MapFieldTypeConverter
MONEY - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
multiValued(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Whether or not this field should contain a list of values.
multiValuedCombinedPropertyRootPath(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: For fields which are both FieldDefinition.FieldDefinitionBuilder.multiValued AND FieldDefinition.FieldDefinitionBuilder.combined, this will be path to the list containing the objects representing each value.

N

nextPageable() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
NotFoundIndexable - Class in com.broadleafcommerce.search.api.domain: Represents and indexable that was not found when querying a service.
NotFoundIndexable() - Constructor for class com.broadleafcommerce.search.api.domain.NotFoundIndexable

P

PERMANENT - Enum constant in enum class com.broadleafcommerce.search.api.type.RedirectType
previousPageable() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
PRODUCT - Enum constant in enum class com.broadleafcommerce.search.api.domain.accesspolicy.DefaultCatalogAccessPolicyTargetType: Restricts access to any products that match across all catalogs
propertyPath(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The JSON path of this field excluding the root prefix, "$.".
propertyPaths(List<String>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: If this is a combined field, these are the JSON paths to the fields to be combined into the final value, excluding the root prefix, "$.".

R

RedirectType - Enum Class in com.broadleafcommerce.search.api.type: Enumeration of the types of redirects available to configure for search.
ReindexProvider<D> - Interface in com.broadleafcommerce.search.provider: Generic interface for writing a record or document to a particular index, such as Solr.
retrieveFieldType(String) - Method in interface com.broadleafcommerce.search.api.service.FieldTypeConverter: Retrieve the generic field type from the implementation specific type.
retrieveFieldType(String) - Method in class com.broadleafcommerce.search.api.service.MapFieldTypeConverter
RetryableOperationUtil - Class in com.broadleafcommerce.search.util: Component to allow for retry-able operations.
RetryableOperationUtil() - Constructor for class com.broadleafcommerce.search.util.RetryableOperationUtil
RuleFilter - Class in com.broadleafcommerce.search.api.domain: Represents the rule filter to be searched.
RuleFilter() - Constructor for class com.broadleafcommerce.search.api.domain.RuleFilter

S

SandboxTrackable - Interface in com.broadleafcommerce.search.api.domain: Interface for objects which are sandbox trackable.
search(Q, IndexableType) - Method in interface com.broadleafcommerce.search.provider.SearchProvider: Execute a search for the provided requested implementation-specific query and type.
search(Q, String) - Method in interface com.broadleafcommerce.search.provider.SearchProvider: Execute a search for the provided requested implementation-specific query and the collection.
searchable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Whether or not the search query should be applied to this field on search.
SearchCatalogAccessPolicy - Class in com.broadleafcommerce.search.api.domain.accesspolicy: Represents a set of rules concerning what Catalog entities can be accessed by the specified users.
SearchCatalogAccessPolicy() - Constructor for class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy
SearchCatalogAccessPolicyContext - Class in com.broadleafcommerce.search.api.domain.accesspolicy: Context to evaluate against the matchRules of the resolved CatalogAccessPolicies.
SearchCatalogAccessPolicyContext() - Constructor for class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext
SearchCatalogAccessPolicyProperties - Class in com.broadleafcommerce.search.autoconfigure: Properties related to SearchCatalogAccessPolicy
SearchCatalogAccessPolicyProperties() - Constructor for class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties
SearchCommonAutoConfiguration - Class in com.broadleafcommerce.search.autoconfigure
SearchCommonAutoConfiguration() - Constructor for class com.broadleafcommerce.search.autoconfigure.SearchCommonAutoConfiguration
SearchCommonTranslationProperties - Class in com.broadleafcommerce.search.autoconfigure: Properties related to document translations for search and indexing.
SearchCommonTranslationProperties() - Constructor for class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties
SearchException - Exception in com.broadleafcommerce.search.api
SearchException() - Constructor for exception com.broadleafcommerce.search.api.SearchException
SearchException(String) - Constructor for exception com.broadleafcommerce.search.api.SearchException
SearchException(String, Throwable) - Constructor for exception com.broadleafcommerce.search.api.SearchException
SearchException(String, Throwable, boolean, boolean) - Constructor for exception com.broadleafcommerce.search.api.SearchException
SearchException(Throwable) - Constructor for exception com.broadleafcommerce.search.api.SearchException
SearchIndexException - Exception in com.broadleafcommerce.search.api: Generic checked exception for search.
SearchIndexException() - Constructor for exception com.broadleafcommerce.search.api.SearchIndexException
SearchIndexException(String) - Constructor for exception com.broadleafcommerce.search.api.SearchIndexException
SearchIndexException(String, Throwable) - Constructor for exception com.broadleafcommerce.search.api.SearchIndexException
SearchIndexException(String, Throwable, boolean, boolean) - Constructor for exception com.broadleafcommerce.search.api.SearchIndexException
SearchIndexException(Throwable) - Constructor for exception com.broadleafcommerce.search.api.SearchIndexException
SearchProvider<Q,R> - Interface in com.broadleafcommerce.search.provider: Generic interface for searching on a particular index, such as Solr.
SearchRedirect - Class in com.broadleafcommerce.search.api.domain: This represents a redirect which should be performed based on a search query.
SearchRedirect() - Constructor for class com.broadleafcommerce.search.api.domain.SearchRedirect
SearchRedirectResponse - Class in com.broadleafcommerce.search.api.domain: A response object indicating that the client should be redirected based on the original search query.
SearchRedirectResponse() - Constructor for class com.broadleafcommerce.search.api.domain.SearchRedirectResponse
SearchRequest - Class in com.broadleafcommerce.search.api.domain: Represents the request for a query to be searched.
SearchRequest() - Constructor for class com.broadleafcommerce.search.api.domain.SearchRequest
SearchResponse - Class in com.broadleafcommerce.search.api.domain: Represents the results from a search.
SearchResponse(List<Object>, Pageable, long) - Constructor for class com.broadleafcommerce.search.api.domain.SearchResponse
SearchSettings - Class in com.broadleafcommerce.search.api.domain: Represents a group of search settings for an application or tenant to allow sharing Facets and SortOptions between different environments.
SearchSettings() - Constructor for class com.broadleafcommerce.search.api.domain.SearchSettings
SearchSettingsProperties - Class in com.broadleafcommerce.search.autoconfigure: Properties for configuring SearchSettings and whether they are in use.
SearchSettingsProperties() - Constructor for class com.broadleafcommerce.search.autoconfigure.SearchSettingsProperties
setAbbreviation(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
setAbbreviation(String) - Method in class com.broadleafcommerce.search.api.domain.FieldRef: Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
setAccountHierarchy(List<String>) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The hierarchy of accounts, from the root account to the account member's account.
setAccountId(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The ID of the account the user belongs to.
setActive(boolean) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: Whether or not this facet value was active on the search
setActive(boolean) - Method in class com.broadleafcommerce.search.api.domain.SortResponse: Whether or not this sort is active.
setActiveEndDate(Instant) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: The date until which the policy should be active.
setActiveStartDate(Instant) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: The date from which the policy should be active.
setAdditionalClaims(List<String>) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties: Represents a list of additional auth token claims to add as attributes to the SearchCatalogAccessPolicyContext for rules to be evaluated against.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: Additional, arbitrary request attributes.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.Facet: Miscellaneous attributes for this facet.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: Miscellaneous attributes for this facet group.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Miscellaneous attributes for this field.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: Miscellaneous attributes for this search settings.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.SortGroup: Miscellaneous attributes for this sort group.
setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.search.api.domain.SortOption: Miscellaneous attributes for this sort option.
setAutocompleteSuggestionLimit(Integer) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The number of autocomplete suggestions to return on a TypeAhead search.
setAutoCorrectQuery(Boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: Optional.
setBoost(Double) - Method in class com.broadleafcommerce.search.api.domain.FieldQuery: The amount to boost this variant for this query type.
setCatalogOmissions(Set<String>) - Method in interface com.broadleafcommerce.search.api.domain.CatalogTrackable: The IDs of descendant catalogs in which this context version of the product has been omitted as a result of one or more filters.
setCatalogOverrides(Set<String>) - Method in interface com.broadleafcommerce.search.api.domain.CatalogTrackable: Set any catalog contexts where this trackable has been overridden.
setCategoryProductMembershipFilters(RuleFilter) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The rule-based RSQL filters used to check if a related product is a member of the specified category.
setCombined(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Whether or not this field should be a combination of multiple path values.
setConfig(String) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: The configuration to use on this TypeAhead query.
setConfigName(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The name of this configuration.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.Facet: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.SortGroup: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.SortOption: A subset of Tracking information to expose the context state for this object.
setContextState(ContextState) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: A subset of Tracking information to expose the context state for this object.
setCorrectedQuery(boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: If no results were found and a different query was executed than the original, this is set to true.
setCustomerSegmentIds(Set<String>) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The list of ids that correspond to customer segments that this customer is a part of.
setDebug(boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: If set to true, a string containing debug information about the query results will be returned.
setDebug(boolean) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: If set to true, a string containing debug information about the query results will be returned.
setDebug(String) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse: The raw query response for debugging purposes.
setDelimiter(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: If this is a combined field, this is the delimiter string which should separate the values found from the propertyPaths.
setDescending(boolean) - Method in class com.broadleafcommerce.search.api.domain.SortResponse: Whether the sort should be descending.
setDisplayOrder(Integer) - Method in class com.broadleafcommerce.search.api.domain.Facet: Order in which to display this facet on a list of facets.
setDisplayOrder(Integer) - Method in class com.broadleafcommerce.search.api.domain.FacetRange: Order in which to display this range on a list of facet ranges.
setDisplayOrder(Integer) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: The display order for this facet value.
setDisplayOrder(Integer) - Method in class com.broadleafcommerce.search.api.domain.SortOption: The display order of this sort option
setEmail(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's email.
setEnabled(boolean) - Method in class com.broadleafcommerce.search.autoconfigure.SearchSettingsProperties: Whether SearchSettings features will be used.
setEnableSpellCheck(Boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: Optional.
setEndOffset(int) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
setEntityField(String) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The name of the field on the entity to which this translation applies.
setEntityId(String) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The ID of the entity to which this translation applies.
setEntityType(String) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The type of the entity to which this translation applies, e.g., PRODUCT, CATEGORY, OFFER.
setFacet(Facet) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: The facet in this relationship.
setFacet(Facet) - Method in class com.broadleafcommerce.search.api.domain.FacetResponse: The facet which was determined in the search.
setFacet(Facet) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The facet which is driven by this field.
setFaceted(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Indicates if this field has a facet.
setFaceted(boolean) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: Is this configuration faceted? Required for showing a result count.
setFacetGroup(FacetGroup) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: The facet group in this relationship
setFacetGroup(FacetGroup) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: The facet group in this relationship
setFacetGroups(Set<FacetGroup>) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The facet groups managed on this search settings.
setFacetRule(String) - Method in class com.broadleafcommerce.search.api.domain.Facet: The rule required to be met for this facet to be active.
setFacets(List<FacetResponse>) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: The facets returned in the search result.
setFacets(Set<Facet>) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The facets in this facet group.
setFacetVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The field variant type which should be faceted on.
setField(FieldRef) - Method in class com.broadleafcommerce.search.api.domain.Facet: The FieldRef this facet belongs to.
setField(FieldRef) - Method in class com.broadleafcommerce.search.api.domain.FieldVariant: The field which this variant represents.
setField(FieldRef) - Method in class com.broadleafcommerce.search.api.domain.SortOption: The field to be sorted on.
setFieldDefinition(FieldDefinition) - Method in class com.broadleafcommerce.search.api.domain.SuggestionField: The field definition to provide suggestions for.
setFieldQueries(List<FieldQuery>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Defines how this field should be queried by variants on particular query types.
setFieldVariantMap(Map<String, FieldVariant>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: A map of each field variant type to the corresponding FieldVariant.
setFilterRules(Map<String, String>) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Filters that should be applied to catalog requests.
setFilters(List<Filter>) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The list of filters to apply to this query.
setFilters(List<Filter>) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: The list of filters to apply to this query.
setFullName(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's full name.
setGroupIndexableType(String) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The indexable type of the fields for this facet group.
setGroupIndexableType(String) - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The indexable type of the fields for this facet group.
setHighlightAppend(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: When highlighting, this is a string that will be prepended to a matching keyword.
setHighlightedSuggestion(String) - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase: A suggested or phrase with highlighting applied.
setHighlightFields(List<SuggestionField>) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The fields to highlight.
setHighlightFragmentSize(int) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The approximate size, in characters, of fragments to consider for highlighting.
setHighlightPrepend(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: When highlighting, this is a string that will be prepended to a matching keyword.
setHits(Long) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
setId(Object) - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
setId(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Id for the policy.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.Facet: The context ID of the facet.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The context ID of the facet group.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: The context ID of the facet group facet relationship.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The context ID of the field.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.FieldRef: The context ID of the field.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The context ID of this search redirect.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The context ID of the search settings.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: The context ID of the settings facet group relationship.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: The context ID of the settings sort group relationship.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The context ID of the sort group.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: The context ID of the sort group sort option xref.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.SortOption: The context ID of the sort option.
setId(String) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The context ID of this Translation
setId(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
setIncludeInResponse(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldVariant: Determines whether or not this variant should be included in the search response.
setIncorrectWord(String) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: The original word in the search query that is misspelled.
setIndexableType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The type to which this field belongs.
setIndexableType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldRef: The type to which this field belongs.
setIndexableType(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The IndexableType this configuration belongs to.
setIndexCountrySpecificLanguageDialects(boolean) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties: Whether to index language dialects identified by country and language, or just the language.
setIndexLanguagesForTenantDefaultLocale(boolean) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties: Whether or not to index the tenant's default locale.
setKeyWords(LinkedHashSet<SuggestionPhrase>) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse: The keywords associated with this response.
setLabel(String) - Method in class com.broadleafcommerce.search.api.domain.Facet: A value intended for display on a UI.
setLabel(String) - Method in class com.broadleafcommerce.search.api.domain.FacetRange: The label for this facet range, suitable for display.
setLabel(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The label of the field, suitable for display.
setLabel(String) - Method in class com.broadleafcommerce.search.api.domain.FieldRef: The label of the field, suitable for display.
setLabel(String) - Method in class com.broadleafcommerce.search.api.domain.SortOption: The label of this search option
setLocale(Locale) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The Locale wherein this Translation is applicable
setMarketplaceApplications(Set<String>) - Method in interface com.broadleafcommerce.search.api.domain.CatalogTrackable: All of the IDs of marketplace applications where this product could appear in, based on the catalog hierarchy.
setMatchRule(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Match rule to evaluate against a context object containing user and request data.
setMaxValue(String) - Method in class com.broadleafcommerce.search.api.domain.FacetRange: The highest value included in this facet range.
setMaxValue(String) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: If ranged, the upper bound of values matching this facet value
setMaxValue(String) - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue: The maximum value to be applied on this filter.
setMinValue(String) - Method in class com.broadleafcommerce.search.api.domain.FacetRange: The lowest value included in this facet range.
setMinValue(String) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: If ranged, the lower bound of values matching this facet value
setMinValue(String) - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue: The minimum value to be applied on this filter value.
setMultiSelect(boolean) - Method in class com.broadleafcommerce.search.api.domain.Facet: Determines whether or not this facet allows multiple values to be selected.
setMultiValued(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Whether or not this field should contain a list of values.
setMultiValuedCombinedPropertyRootPath(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: For fields which are both FieldDefinition.multiValued AND FieldDefinition.combined, this will be path to the list containing the objects representing each value.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: Name of the policy.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.Facet: Name to use to identify the facet.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.FacetGroup: The name of the facet group.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.Filter: The name of the property to filter on, e.g.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: A name to describe the purpose of this search redirect.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The name of the sort group.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.SortOption: Name to use to identify the sort option.
setName(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: The name to be displayed in the results.
setOffsets(List<SpellCheckSuggestion.TermPosition>) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: The offset positions of this string in the original query.
setOriginalQuery(String) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: The original search query.
setOverrideChangeContainer(ChangeContainer) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet
setOverrideChangeContainer(ChangeContainer) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
setOverrideChangeContainer(ChangeContainer) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup
setOverrideChangeContainer(ChangeContainer) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption
setOverrideLocale(Locale) - Method in class com.broadleafcommerce.search.api.domain.RuleFilter: The override locale to be used when evaluating the rule in the RSQLSolrQueryContributor.
setPhoneNumber(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's phone number.
setPhraseSlop(String) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: The phrase slop.
setPropertyPath(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The JSON path of this field excluding the root prefix, "$.".
setPropertyPaths(List<String>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: If this is a combined field, these are the JSON paths to the fields to be combined into the final value, excluding the root prefix, "$.".
setQuantity(int) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: The quantity of results matching this facet value
setQuery(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The raw search query.
setQuery(String) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
setQuery(String) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: The TypeAhead query.
setQueryMatch(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The value that a query must match to activate the redirect.
setQueryType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldQuery: The query type which should be boosted on.
setRanged(boolean) - Method in class com.broadleafcommerce.search.api.domain.Facet: Designates whether or not this facet is ranged.
setRanged(boolean) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: Whether or not this value is a range.
setRanges(List<FacetRange>) - Method in class com.broadleafcommerce.search.api.domain.Facet: The different range options available for filtering on this search facet.
setRanges(List<FilterRangeValue>) - Method in class com.broadleafcommerce.search.api.domain.Filter: The ranged values of this filter.
setRedirect(SearchRedirectResponse) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: A redirect generated based on the original request query.
setRedirectType(RedirectType) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The type of redirect which should be performed.
setRedirectType(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse: The HTTP status type of redirect which should be performed
setRedirectUri(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: The URI which the client should be redirected to if the search query matches.
setRedirectUri(String) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse: The URI to which the client should be redirected.
setRegex(boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect: Whether or not the queryMatch should be applied as a Regex.
setRegistered(boolean) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: Defines whether the user is registered.
setRequestAttributeList(List<String>) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties: Represents the list of attribute from a WebRequest to store on SearchCatalogAccessPolicyContext.
setResultLimit(int) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: The maximum number of results to return for this configuration.
setRootAccountId(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The ID of the root account the account member belongs to.
setRule(String) - Method in class com.broadleafcommerce.search.api.domain.RuleFilter: Rule-based RSQL filters to be searched upon
setRuleFilters(RuleFilter) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: Additional rule-based RSQL filters to apply to this query.
setRuleFilters(RuleFilter) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest: Additional rule-based RSQL filters to apply to this query.
setSandboxOverrides(Set<String>) - Method in interface com.broadleafcommerce.search.api.domain.SandboxTrackable: Set any sandbox contexts where this trackable has been overridden.
setSearchable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Whether or not the search query should be applied to this field on search.
setSearchEnabled(boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: Whether advanced search is enabled.
setSearchSettings(SearchSettings) - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup: The search settings in this relationship
setSearchSettings(SearchSettings) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: The search settings in this relationship
setSettingsContext(String) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The scoped context of this SearchSettings.
setSortable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Indicates if this field is sortable.
setSorted(Boolean) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: Whether the persistent counterpart to this FacetGroupFacet has a non-default value for Sortable.getSorting(), which determines order in admin list grids.
setSorted(Boolean) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: Whether the persistent counterpart to this SortGroupSortOption has a non-default value for Sortable.getSorting(), which determines order in admin list grids.
setSortGroup(SortGroup) - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup: The sort group in this relationship
setSortGroup(SortGroup) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: The sort group in this relationship.
setSortGroups(Set<SortGroup>) - Method in class com.broadleafcommerce.search.api.domain.SearchSettings: The sort groups managed on this search settings.
setSorting(String) - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet: Field indicating a sort order, if sorted.
setSorting(String) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: Field indicating a sort order, if sorted.
setSortOption(SortOption) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The sort option which is driven by this field.
setSortOption(SortOption) - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption: The sort option in this relationship.
setSortOption(SortOption) - Method in class com.broadleafcommerce.search.api.domain.SortResponse: The Sort Option information for this sort.
setSortOptions(Set<SortOption>) - Method in class com.broadleafcommerce.search.api.domain.SortGroup: The sort options in this sort group.
setSorts(List<SortResponse>) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: The sort options returned in the search result.
setSortVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The field variant type which should be sorted on.
setSpellCheckedQuery(boolean) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: This is set to true if this query has already been run once to avoid unnecessarily spellchecking the query a second time.
setSpellCheckResult(SpellCheckResult) - Method in class com.broadleafcommerce.search.api.domain.SearchResponse: Set if spellcheck returned any results.
setStartOffset(int) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
setSuggestedQueries(List<SpellCheckResult.SuggestedQuery>) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: The suggested queries after spell correction, in order of most to least recommended.
setSuggestion(String) - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase: A suggested word or phrase.
setSuggestionFields(List<SuggestionField>) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration: The list of fields to be returned with this suggestion.
setSuggestionMap(Map<String, SpellCheckSuggestion>) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult: Suggested spelling corrections of the original query to retrieve results.
setSuggestions(List<String>) - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion: The suggested terms to replace the corrected word, ordered by recommendation.
setSuggestions(Map<String, List<Map<String, Object>>>) - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse: A map of suggestions, with the key being the name of the origin of the suggestion.
setTargetCatalogIds(List<String>) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: List of the target Catalog.getId() that this catalog access policy applies to.
setTargetType(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy: The target type denoting how to restrict this catalog access policy.
setTerm(String) - Method in class com.broadleafcommerce.search.api.domain.typeahead.Suggestion: The suggested term.
SettingsFacetGroup - Class in com.broadleafcommerce.search.api.domain: Links a SortGroup to a SearchSettings instance.
SettingsFacetGroup() - Constructor for class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
SettingsSortGroup - Class in com.broadleafcommerce.search.api.domain: Links a SortGroup to a SearchSettings instance.
SettingsSortGroup() - Constructor for class com.broadleafcommerce.search.api.domain.SettingsSortGroup
setTranslatable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: Indicates if this field is translatable.
setTranslatable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldRef: Indicates if this field is translatable.
setType(IndexableType) - Method in class com.broadleafcommerce.search.api.domain.NotFoundIndexable
setType(IndexableType) - Method in class com.broadleafcommerce.search.api.domain.SearchRequest: The IndexableType for this query.
setType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldVariant: The general type of value stored in this field.
setTypeAheadSuggestionConfigurations(List<TypeAheadSuggestionConfiguration>) - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration: Configurations defining what should be returned on a TypeAhead query.
setTypeHint(String) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: The type hint for this translation.
setUserId(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's id.
setUsername(String) - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext: The user's username.
setValue(Object) - Method in class com.broadleafcommerce.search.api.domain.translation.Translation: This field holds the actual translated value.
setValue(String) - Method in class com.broadleafcommerce.search.api.domain.FacetValue: The value label for this facet value.
setValues(List<FacetValue>) - Method in class com.broadleafcommerce.search.api.domain.FacetResponse: The values returned from search for this facet.
setValues(List<String>) - Method in class com.broadleafcommerce.search.api.domain.Filter: The values of the filter.
setVariants(List<FieldVariant>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition: The specific typed variants for this field.
setVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.Facet: The field variant type which should be faceted on.
setVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldQuery: The field variant type which should be boosted on.
setVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.SortOption: The field variant type which should be sorted on.
setVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.SuggestionField: The variant type to use when building suggestions.
setWhitelistedServiceCallers(Set<String>) - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties: The names of external microservices that are expected to call Search Service for admin or bulk processing requests and should be whitelisted so that they bypass Catalog Access Policy filtering.
shouldIndexCountrySpecificLanguageDialects() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties
shouldIndexLanguagesForTenantDefaultLocale() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties
sortable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Indicates if this field is sortable.
SortGroup - Class in com.broadleafcommerce.search.api.domain: Provides a way to group related SortOptions to easily reuse them in different contexts.
SortGroup() - Constructor for class com.broadleafcommerce.search.api.domain.SortGroup
SortGroupSortOption - Class in com.broadleafcommerce.search.api.domain: Represents a link between a SortOption and a SortGroup.
SortGroupSortOption() - Constructor for class com.broadleafcommerce.search.api.domain.SortGroupSortOption
sortOption(SortOption) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The sort option which is driven by this field.
SortOption - Class in com.broadleafcommerce.search.api.domain: A sorting option for a particular field.
SortOption() - Constructor for class com.broadleafcommerce.search.api.domain.SortOption
SortResponse - Class in com.broadleafcommerce.search.api.domain: Information on the active sorting and available sorts for a SearchResponse.
SortResponse() - Constructor for class com.broadleafcommerce.search.api.domain.SortResponse
sortVariantType(String) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The field variant type which should be sorted on.
SPELL_CHECK - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
SPELL_CHECKS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
SpellCheckResult - Class in com.broadleafcommerce.search.api.domain
SpellCheckResult(String) - Constructor for class com.broadleafcommerce.search.api.domain.SpellCheckResult
SpellCheckResult.SuggestedQuery - Class in com.broadleafcommerce.search.api.domain
SpellCheckSuggestion - Class in com.broadleafcommerce.search.api.domain: Represents a set of spelling suggestions on a spelling corrected term.
SpellCheckSuggestion(String, List<String>, int, int) - Constructor for class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion
SpellCheckSuggestion.TermPosition - Class in com.broadleafcommerce.search.api.domain
status() - Method in enum class com.broadleafcommerce.search.api.type.RedirectType: Get the HTTP status associated with the redirect type, to be used when performing the redirect.
STOREFRONT - Enum constant in enum class com.broadleafcommerce.search.api.type.DefaultSettingsContextType
STRING - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
STRING_LOWERCASE - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
STRINGS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
STRINGS_LOWERCASE - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
SuggestedQuery(String, Long) - Constructor for class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
Suggestion - Class in com.broadleafcommerce.search.api.domain.typeahead: Returned in a TypeAheadResult, this contains suggestion values returned by the search engine.
Suggestion() - Constructor for class com.broadleafcommerce.search.api.domain.typeahead.Suggestion
Suggestion(String) - Constructor for class com.broadleafcommerce.search.api.domain.typeahead.Suggestion
SuggestionField - Class in com.broadleafcommerce.search.api.domain: Signifies a field to be used in a suggestion.
SuggestionField() - Constructor for class com.broadleafcommerce.search.api.domain.SuggestionField
SuggestionPhrase - Class in com.broadleafcommerce.search.api.domain.typeahead: Represents a single search autocomplete suggestion
SuggestionPhrase() - Constructor for class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase

T

TEMPORARY - Enum constant in enum class com.broadleafcommerce.search.api.type.RedirectType
TEXT - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXT_PARTIAL - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXT_PARTIALS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXT_PHONETIC - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXT_PHONETICS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXT_TYPE_AHEAD - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXT_TYPE_AHEADS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
TEXTS - Static variable in class com.broadleafcommerce.search.api.type.DefaultFieldType
toString() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicy
toString() - Method in class com.broadleafcommerce.search.api.domain.accesspolicy.SearchCatalogAccessPolicyContext
toString() - Method in class com.broadleafcommerce.search.api.domain.Facet
toString() - Method in class com.broadleafcommerce.search.api.domain.FacetGroup
toString() - Method in class com.broadleafcommerce.search.api.domain.FacetGroupFacet
toString() - Method in class com.broadleafcommerce.search.api.domain.FacetRange
toString() - Method in class com.broadleafcommerce.search.api.domain.FacetResponse
toString() - Method in class com.broadleafcommerce.search.api.domain.FacetValue
toString() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder
toString() - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition
toString() - Method in class com.broadleafcommerce.search.api.domain.FieldQuery
toString() - Method in class com.broadleafcommerce.search.api.domain.FieldRef
toString() - Method in class com.broadleafcommerce.search.api.domain.FieldVariant
toString() - Method in class com.broadleafcommerce.search.api.domain.Filter
toString() - Method in class com.broadleafcommerce.search.api.domain.FilterRangeValue
toString() - Method in class com.broadleafcommerce.search.api.domain.RuleFilter
toString() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirect
toString() - Method in class com.broadleafcommerce.search.api.domain.SearchRedirectResponse
toString() - Method in class com.broadleafcommerce.search.api.domain.SearchRequest
toString() - Method in class com.broadleafcommerce.search.api.domain.SearchResponse
toString() - Method in class com.broadleafcommerce.search.api.domain.SearchSettings
toString() - Method in class com.broadleafcommerce.search.api.domain.SettingsFacetGroup
toString() - Method in class com.broadleafcommerce.search.api.domain.SettingsSortGroup
toString() - Method in class com.broadleafcommerce.search.api.domain.SortGroup
toString() - Method in class com.broadleafcommerce.search.api.domain.SortGroupSortOption
toString() - Method in class com.broadleafcommerce.search.api.domain.SortOption
toString() - Method in class com.broadleafcommerce.search.api.domain.SortResponse
toString() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult.SuggestedQuery
toString() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckResult
toString() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion.TermPosition
toString() - Method in class com.broadleafcommerce.search.api.domain.SpellCheckSuggestion
toString() - Method in class com.broadleafcommerce.search.api.domain.SuggestionField
toString() - Method in class com.broadleafcommerce.search.api.domain.translation.Translation
toString() - Method in class com.broadleafcommerce.search.api.domain.typeahead.Suggestion
toString() - Method in class com.broadleafcommerce.search.api.domain.typeahead.SuggestionPhrase
toString() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest
toString() - Method in class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse
toString() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
toString() - Method in class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration
toString() - Method in class com.broadleafcommerce.search.api.type.IndexableType
toString() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCatalogAccessPolicyProperties
toString() - Method in class com.broadleafcommerce.search.autoconfigure.SearchCommonTranslationProperties
translatable(boolean) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: Indicates if this field is translatable.
Translation - Class in com.broadleafcommerce.search.api.domain.translation: Defines an entity that holds the value for a translation of a String field on another entity in a particular Locale.
Translation() - Constructor for class com.broadleafcommerce.search.api.domain.translation.Translation
Translation(String, Locale, String, String, String, Object, String, ContextState) - Constructor for class com.broadleafcommerce.search.api.domain.translation.Translation
TypeAheadConfiguration - Class in com.broadleafcommerce.search.api.domain
TypeAheadConfiguration() - Constructor for class com.broadleafcommerce.search.api.domain.TypeAheadConfiguration
TypeAheadException - Exception in com.broadleafcommerce.search.api
TypeAheadException(Exception) - Constructor for exception com.broadleafcommerce.search.api.TypeAheadException
TypeAheadException(String) - Constructor for exception com.broadleafcommerce.search.api.TypeAheadException
TypeAheadException(String, Throwable) - Constructor for exception com.broadleafcommerce.search.api.TypeAheadException
TypeAheadRequest - Class in com.broadleafcommerce.search.api.domain.typeahead: Represents the request data for a type-ahead request.
TypeAheadRequest() - Constructor for class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest
TypeAheadResponse - Class in com.broadleafcommerce.search.api.domain.typeahead
TypeAheadResponse() - Constructor for class com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse
TypeAheadSuggestionConfiguration - Class in com.broadleafcommerce.search.api.domain: Represents a suggestion to be returned in a TypeAheadResponse.
TypeAheadSuggestionConfiguration() - Constructor for class com.broadleafcommerce.search.api.domain.TypeAheadSuggestionConfiguration

V

value() - Element in annotation interface com.broadleafcommerce.search.api.type.annotations.IndexableTypes
valueOf(String) - Static method in enum class com.broadleafcommerce.search.api.domain.accesspolicy.DefaultCatalogAccessPolicyTargetType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.search.api.type.DefaultSettingsContextType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.broadleafcommerce.search.api.type.RedirectType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.search.api.domain.accesspolicy.DefaultCatalogAccessPolicyTargetType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.search.api.type.DefaultSettingsContextType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.broadleafcommerce.search.api.type.RedirectType: Returns an array containing the constants of this enum class, in the order they are declared.
variants(List<FieldVariant>) - Method in class com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder: The specific typed variants for this field.

W

write(D, String...) - Method in interface com.broadleafcommerce.search.provider.ReindexProvider: Writes a document or record to one or more indices.
write(List<D>, String...) - Method in interface com.broadleafcommerce.search.provider.ReindexProvider: Writes a batch of documents to one or more indices.

A B C D E F G H I L M N P R S T V W
All Classes and Interfaces|All Packages|Serialized Form