Uses of Class
com.broadleafcommerce.search.api.domain.FieldDefinition.FieldDefinitionBuilder

Packages that use FieldDefinition.FieldDefinitionBuilder

Package	Description
com.broadleafcommerce.search.api.domain

Uses of FieldDefinition.FieldDefinitionBuilder in com.broadleafcommerce.search.api.domain

Methods in com.broadleafcommerce.search.api.domain that return FieldDefinition.FieldDefinitionBuilder

Modifier and Type	Method	Description
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.abbreviation(String abbreviation)	Short field name which will be used for request parameters for example in sorting and filtering, as well as response field names.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.attributes(Map<String,Object> attributes)	Miscellaneous attributes for this field.
static FieldDefinition.FieldDefinitionBuilder	FieldDefinition.builder()
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.combined(boolean combined)	Whether or not this field should be a combination of multiple path values.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.delimiter(String delimiter)	If this is a combined field, this is the delimiter string which should separate the values found from the propertyPaths.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.facet(Facet facet)	The facet which is driven by this field.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.faceted(boolean faceted)	Indicates if this field has a facet.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.facetVariantType(String facetVariantType)	The field variant type which should be faceted on.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.fieldQueries(List<FieldQuery> fieldQueries)	Defines how this field should be queried by variants on particular query types.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.fieldVariantMap(Map<String,FieldVariant> fieldVariantMap)	A map of each field variant type to the corresponding FieldVariant.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.id(String id)	The context ID of the field.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.indexableType(String indexableType)	The type to which this field belongs.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.label(String label)	The label of the field, suitable for display.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.multiValued(boolean multiValued)	Whether or not this field should contain a list of values.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.multiValuedCombinedPropertyRootPath(String multiValuedCombinedPropertyRootPath)	For fields which are both multiValued AND combined, this will be path to the list containing the objects representing each value.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.propertyPath(String propertyPath)	The JSON path of this field excluding the root prefix, "$.".
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.propertyPaths(List<String> propertyPaths)	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, "$.".
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.searchable(boolean searchable)	Whether or not the search query should be applied to this field on search.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.sortable(boolean sortable)	Indicates if this field is sortable.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.sortOption(SortOption sortOption)	The sort option which is driven by this field.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.sortVariantType(String sortVariantType)	The field variant type which should be sorted on.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.translatable(boolean translatable)	Indicates if this field is translatable.
FieldDefinition.FieldDefinitionBuilder	FieldDefinition.FieldDefinitionBuilder.variants(List<FieldVariant> variants)	The specific typed variants for this field.