org.broadleafcommerce.core.search.dao

Interface FieldDao

All Known Implementing Classes:

FieldDaoImpl

public interface FieldDao

DAO to facilitate interaction with Broadleaf fields.

Author:

Andre Azzolini (apazzolini)

Method Summary

Methods

Modifier and Type	Method and Description
List<Field>	readAllProductFields() Reads all Field objects that are set to searchable.
Field	readFieldByAbbreviation(String abbreviation) Given an abbreviation, returns the Field object that maps to this abbreviation.
Field	save(Field field) Persist an instance to the data layer.

Method Detail

readFieldByAbbreviation

Field readFieldByAbbreviation(String abbreviation)

Given an abbreviation, returns the Field object that maps to this abbreviation. Note that the default Broadleaf implementation of Field will enforce a uniqueness constraint on the abbreviation field and this method will reliably return one field

Parameters:

abbreviation -

Returns:

the Field that has this abbreviation

readAllProductFields

List<Field> readAllProductFields()

Reads all Field objects that are set to searchable. This is typically used to build an index for searching. Note that the default Broadleaf implementation returns only fields that have a FieldEntity equal to PRODUCT

Returns:

the product Fields

save

Field save(Field field)

Persist an instance to the data layer.

Parameters:

field - the instance to persist

Returns:

the instance after it has been persisted