org.ametys.cms.search.model

Interface SearchModel

All Known Subinterfaces:

SearchUIModel

All Known Implementing Classes:

AbstractSearchUIModel, CriteriaSearchUIModelWrapper, DefaultSearchModel, DynamicWrappedSearchUIModel, IndexedContentsSearchUIModel, ReferenceTableSearchUIModel, StaticSearchUIModel

public interface SearchModel

This interface represents a search model.

Method Summary

Modifier and Type	Method and Description
Set<String>	getContentTypes(Map<String,Object> contextualParameters) Get the list of content types.
Map<String,? extends SearchCriterion>	getCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in simple mode
default SearchCriterion	getCriterion(String id, Map<String,Object> contextualParameters) Get a simple search criterion by its id
Set<String>	getExcludedContentTypes(Map<String,Object> contextualParameters) Get the list of excluded content types.
Map<String,? extends SearchCriterion>	getFacetedCriteria(Map<String,Object> contextualParameters) Get the list of faceted search criteria.
default SearchCriterion	getFacetedCriterion(String id, Map<String,Object> contextualParameters) Get a faceted search criterion by its id.
default ResultField	getResultField(String id, Map<String,Object> contextualParameters) Get the column by its identifier
Map<String,? extends ResultField>	getResultFields(Map<String,Object> contextualParameters) Get the column for results

Method Detail

getContentTypes

Set<String> getContentTypes(Map<String,Object> contextualParameters)

Get the list of content types.

Parameters:

contextualParameters - the contextual parameters.

Returns:

The list of content types.

getExcludedContentTypes

Set<String> getExcludedContentTypes(Map<String,Object> contextualParameters)

Get the list of excluded content types.

Parameters:

contextualParameters - the contextual parameters

Returns:

The list of excluded content types.

getCriteria

Map<String,? extends SearchCriterion> getCriteria(Map<String,Object> contextualParameters)

Get the list of search criteria in simple mode

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

getCriterion

default SearchCriterion getCriterion(String id,
                                     Map<String,Object> contextualParameters)

Get a simple search criterion by its id

Parameters:

id - The search criterion id

contextualParameters - the contextual parameters

Returns:

the criterion or null if not found

getFacetedCriteria

Map<String,? extends SearchCriterion> getFacetedCriteria(Map<String,Object> contextualParameters)

Get the list of faceted search criteria.

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of faceted search criteria.

getFacetedCriterion

default SearchCriterion getFacetedCriterion(String id,
                                            Map<String,Object> contextualParameters)

Get a faceted search criterion by its id.

Parameters:

id - The faceted search criterion id.

contextualParameters - the contextual parameters

Returns:

the faceted criterion or null if not found

getResultFields

Map<String,? extends ResultField> getResultFields(Map<String,Object> contextualParameters)

Get the column for results

Parameters:

contextualParameters - the contextual parameters. Can be null.

Returns:

the column for results

getResultField

default ResultField getResultField(String id,
                                   Map<String,Object> contextualParameters)

Get the column by its identifier

Parameters:

id - The column id

contextualParameters - the contextual parameters

Returns:

the column