org.broadleafcommerce.core.search.domain

Interface Field

All Superinterfaces:

MultiTenantCloneable<Field>, Serializable

All Known Implementing Classes:

FieldImpl

public interface Field
extends Serializable, MultiTenantCloneable<Field>

Represents a String-based mapping of entities and properties. This is used in various places, including search facets and report fields.

Author:

Andre Azzolini (apazzolini)

Method Summary

Methods

Modifier and Type	Method and Description
String	getAbbreviation() Gets the abbreviation of this Field.
FieldEntity	getEntityType() Gets the entityType of this Field
String	getFriendlyName() Returns the friendly name of the field, for use by admin or other UI.
Long	getId() Gets the id
String	getPropertyName() Gets the propertyName of this Field.
String	getQualifiedFieldName() Returns the qualified name of this Field.
List<SearchConfig>	getSearchConfigs() Deprecated.
Boolean	getTranslatable() Returns whether or not this field should be considered translatable
void	setAbbreviation(String abbreviation) Sets the abbreviation
void	setEntityType(FieldEntity entityType) Sets the entityType
void	setFriendlyName(String friendlyName) The friendly name of the field, for use by admin or other UI.
void	setId(Long id) Sets the id
void	setPropertyName(String propertyName) Sets the propertyName
void	setSearchConfigs(List<SearchConfig> searchConfigs) Deprecated.
void	setTranslatable(Boolean translatable) Sets whether or not this field should be considered translatable

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

createOrRetrieveCopyInstance

Method Detail

getId

Long getId()

Gets the id

Returns:

the id

setId

void setId(Long id)

Sets the id

Parameters:

id -

setFriendlyName

void setFriendlyName(String friendlyName)

The friendly name of the field, for use by admin or other UI.

Parameters:

friendlyName -

getFriendlyName

String getFriendlyName()

Returns the friendly name of the field, for use by admin or other UI.

Returns:

getEntityType

FieldEntity getEntityType()

Gets the entityType of this Field

Returns:

the entityType

setEntityType

void setEntityType(FieldEntity entityType)

Sets the entityType

Parameters:

entityType -

getPropertyName

String getPropertyName()

Gets the propertyName of this Field. This would be something like "manufacturer" or "defaultSku.price" if the EntityType was "product"

Returns:

the propertyName

setPropertyName

void setPropertyName(String propertyName)

Sets the propertyName

Parameters:

propertyName -

getAbbreviation

String getAbbreviation()

Gets the abbreviation of this Field. This will be used in URL query string parameters for sorting and filtering

Returns:

the abbreviation

setAbbreviation

void setAbbreviation(String abbreviation)

Sets the abbreviation

Parameters:

abbreviation -

getSearchConfigs

@Deprecated
List<SearchConfig> getSearchConfigs()

Deprecated.

Gets the searchConfigs. Note that a concrete implementation or usage of this class is not available in the community version of Broadleaf Commerce.

Returns:

the searchConfigs

setSearchConfigs

@Deprecated
void setSearchConfigs(List<SearchConfig> searchConfigs)

Deprecated.

Sets the searchConfigs.

Parameters:

searchConfigs -

getQualifiedFieldName

String getQualifiedFieldName()

Returns the qualified name of this Field. The default implementation returns the entityType joined with the properName by a "."

Returns:

the qualifiedFieldName

getTranslatable

Boolean getTranslatable()

Returns whether or not this field should be considered translatable

Returns:

translatable

setTranslatable

void setTranslatable(Boolean translatable)

Sets whether or not this field should be considered translatable

Parameters:

translatable -