org.ametys.cms.search.model

Interface ResultField

All Superinterfaces:

Field

All Known Subinterfaces:

MetadataResultField, SearchUIColumn, SystemResultField

All Known Implementing Classes:

AbstractSearchUIColumn, DefaultMetadataSearchUIColumn, MetadataSearchUIColumn, SystemSearchUIColumn

public interface ResultField
extends Field

Represents a Field to be returned by a search.

Method Summary

Modifier and Type	Method and Description
default Object	getFullValue(Content content, Locale defaultLocale) Get the value represented by this field in the given result content.
String	getId() Get the result field ID.
SearchField	getSearchField() Get the SearchField representing this result field.
Object	getValue(Content content, Locale defaultLocale) Get the value represented by this field in the given result content.

Methods inherited from interface org.ametys.cms.search.model.Field

getContentTypeId, getEnumerator, getType, isMultiple

Method Detail

getId

String getId()

Get the result field ID.

Returns:

the result field ID.

getValue

Object getValue(Content content,
                Locale defaultLocale)

Get the value represented by this field in the given result content.

Parameters:

content - the result content.

defaultLocale - the default locale for localized value if the content's language is null

Returns:

the content field value (cast to the appropriate object).

getFullValue

default Object getFullValue(Content content,
                            Locale defaultLocale)

Get the value represented by this field in the given result content.

Parameters:

content - the result content.

defaultLocale - the default locale for localized value if the content's language is null

Returns:

the content field value (cast to the appropriate object).

getSearchField

SearchField getSearchField()

Get the SearchField representing this result field.

Returns:

The SearchField representing this result field.