org.ametys.cms.search.ui.model

Interface SearchUIModel

All Superinterfaces:

SearchModel

All Known Implementing Classes:

AbstractSearchUIModel, CriteriaSearchUIModelWrapper, DynamicWrappedSearchUIModel, SimpleContentSearchUIModel, StaticSearchUIModel

public interface SearchUIModel
extends SearchModel

Search tool model.

Method Summary

Modifier and Type	Method and Description
Map<String,SearchUICriterion>	getAdvancedCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in advanced mode
default SearchUICriterion	getAdvancedCriterion(String id, Map<String,Object> contextualParameters) Get an advanced search criterion by its id.
Map<String,SearchUICriterion>	getCriteria(Map<String,Object> contextualParameters) Get the list of search criteria in simple mode
default SearchUICriterion	getCriterion(String id, Map<String,Object> contextualParameters) Get a simple search criterion by its id
String	getExportCSVUrl(Map<String,Object> contextualParameters) Get the URL for CVS export of results
String	getExportCSVUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for CVS export of results
String	getExportXMLUrl(Map<String,Object> contextualParameters) Get the URL for XML export of results
String	getExportXMLUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for XML export of results
Map<String,SearchUICriterion>	getFacetedCriteria(Map<String,Object> contextualParameters) Get the list of faceted search criteria.
default SearchUICriterion	getFacetedCriterion(String id, Map<String,Object> contextualParameters) Get a faceted search criterion by its id.
int	getPageSize(Map<String,Object> contextualParameters) Get the page size.
String	getPrintUrl(Map<String,Object> contextualParameters) Get the URL for print results
String	getPrintUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for print results
default SearchUIColumn	getResultField(String id, Map<String,Object> contextualParameters) Get the column by its identifier
Map<String,SearchUIColumn>	getResultFields(Map<String,Object> contextualParameters) Get the column for results
String	getSearchUrl(Map<String,Object> contextualParameters) Get the URL for search
String	getSearchUrlPlugin(Map<String,Object> contextualParameters) Get the plugin name for search
String	getWorkspace(Map<String,Object> contextualParameters) Get the specific workspace to use.

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

getContentTypes, getExcludedContentTypes

Method Detail

getCriteria

Map<String,SearchUICriterion> getCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of search criteria in simple mode

Specified by:

getCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in simple mode

getCriterion

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

Description copied from interface: SearchModel

Get a simple search criterion by its id

Specified by:

getCriterion in interface SearchModel

Parameters:

id - The search criterion id

contextualParameters - the contextual parameters

Returns:

the criterion or null if not found

getFacetedCriteria

Map<String,SearchUICriterion> getFacetedCriteria(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the list of faceted search criteria.

Specified by:

getFacetedCriteria in interface SearchModel

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of faceted search criteria.

getFacetedCriterion

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

Description copied from interface: SearchModel

Get a faceted search criterion by its id.

Specified by:

getFacetedCriterion in interface SearchModel

Parameters:

id - The faceted search criterion id.

contextualParameters - the contextual parameters

Returns:

the faceted criterion or null if not found

getResultFields

Map<String,SearchUIColumn> getResultFields(Map<String,Object> contextualParameters)

Description copied from interface: SearchModel

Get the column for results

Specified by:

getResultFields in interface SearchModel

Parameters:

contextualParameters - the contextual parameters. Can be null.

Returns:

the column for results

getResultField

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

Description copied from interface: SearchModel

Get the column by its identifier

Specified by:

getResultField in interface SearchModel

Parameters:

id - The column id

contextualParameters - the contextual parameters

Returns:

the column

getAdvancedCriteria

Map<String,SearchUICriterion> getAdvancedCriteria(Map<String,Object> contextualParameters)

Get the list of search criteria in advanced mode

Parameters:

contextualParameters - the contextual parameters

Returns:

the list of search criteria in advanced mode

getAdvancedCriterion

default SearchUICriterion getAdvancedCriterion(String id,
                                               Map<String,Object> contextualParameters)

Get an advanced search criterion by its id.

Parameters:

id - The advanced search criterion id.

contextualParameters - the contextual parameters

Returns:

the advanced criterion or null if not found

getPageSize

int getPageSize(Map<String,Object> contextualParameters)

Get the page size.

Parameters:

contextualParameters - the contextual parameters.

Returns:

The page size, unlimited or default used when negative or 0.

getWorkspace

String getWorkspace(Map<String,Object> contextualParameters)

Get the specific workspace to use.

Parameters:

contextualParameters - the contextual parameters.

Returns:

the workspace to use when searching, or null to use the default workspace.

getSearchUrl

String getSearchUrl(Map<String,Object> contextualParameters)

Get the URL for search

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for search

getSearchUrlPlugin

String getSearchUrlPlugin(Map<String,Object> contextualParameters)

Get the plugin name for search

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for search

getExportCSVUrl

String getExportCSVUrl(Map<String,Object> contextualParameters)

Get the URL for CVS export of results

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for CVS export

getExportCSVUrlPlugin

String getExportCSVUrlPlugin(Map<String,Object> contextualParameters)

Get the plugin name for CVS export of results

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for CVS export

getExportXMLUrl

String getExportXMLUrl(Map<String,Object> contextualParameters)

Get the URL for XML export of results

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for XML export

getExportXMLUrlPlugin

String getExportXMLUrlPlugin(Map<String,Object> contextualParameters)

Get the plugin name for XML export of results

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for XML export

getPrintUrl

String getPrintUrl(Map<String,Object> contextualParameters)

Get the URL for print results

Parameters:

contextualParameters - the contextual parameters

Returns:

the URL for print results

getPrintUrlPlugin

String getPrintUrlPlugin(Map<String,Object> contextualParameters)

Get the plugin name for print results

Parameters:

contextualParameters - the contextual parameters

Returns:

the plugin name for print results