org.broadleafcommerce.core.search.domain

Interface IndexField

All Superinterfaces:

MultiTenantCloneable<IndexField>, Serializable

All Known Implementing Classes:

IndexFieldImpl

public interface IndexField
extends Serializable, MultiTenantCloneable<IndexField>

Represents a field that gets stored in the search index

Author:

Chad Harchar (charchar)

Method Summary

Methods

Modifier and Type	Method and Description
Field	getField() Gets the field for this search field
List<IndexFieldType>	getFieldTypes() Gets the searchable field types for this search field
Long	getId() Gets the id for this search field
Boolean	getSearchable() Whether or not the user should see results for this field when typing in search terms in the omnibox, or if this is just a field stored in the index (like margin or sorts)
void	setField(Field field) Sets the field for this search field
void	setFieldTypes(List<IndexFieldType> fieldTypes) Sets the searchable field types for this search field
void	setId(Long id) Sets the id for this search field
void	setSearchable(Boolean searchable)

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getId

Long getId()

Gets the id for this search field

Returns:

setId

void setId(Long id)

Sets the id for this search field

Parameters:

id -

getSearchable

Boolean getSearchable()

Whether or not the user should see results for this field when typing in search terms in the omnibox, or if this is just a field stored in the index (like margin or sorts)

setSearchable

void setSearchable(Boolean searchable)

getField

Field getField()

Gets the field for this search field

Returns:

setField

void setField(Field field)

Sets the field for this search field

Parameters:

field -

getFieldTypes

List<IndexFieldType> getFieldTypes()

Gets the searchable field types for this search field

Returns:

setFieldTypes

void setFieldTypes(List<IndexFieldType> fieldTypes)

Sets the searchable field types for this search field

Parameters:

fieldTypes -