Package org.ametys.web.frontoffice.search.instance

Class SearchServiceInstance

java.lang.Object

org.ametys.web.frontoffice.search.instance.SearchServiceInstance

public class SearchServiceInstance
extends Object

A wrapper class representing an instance of SearchService.
It can be seen as a ZoneItem as well as a FO SearchModel created on the fly by the webmaster.

Method Summary

Modifier and Type	Method	Description
boolean	computeCriteriaCounts()	Returns true if the counts of enumerated criteria must be computed
Collection<AdditionalSearchServiceParameter>	getAdditionalParameters()	Gets the additional parameters
AdditionalParameterValueMap	getAdditionalParameterValues()	Gets the additional parameter values
Collection<SearchContext>	getContexts()	Gets the SearchContexts
Optional<AbstractTreeNode<SearchServiceCriterion<?>>>	getCriterionTree()	Gets the tree of SearchServiceCriteria
Collection<SearchServiceFacetDefinition>	getFacets()	Gets the SearchServiceFacetDefinitions
String	getId()	Gets the id
List<Pair<SearchServiceSortDefinition,SortOrder>>	getInitialSorts()	Gets the initial SearchServiceSortDefinitions with their sort order
Link	getLink()	Gets the link
Collection<SearchServiceSortDefinition>	getProposedSorts()	Gets the proposed SearchServiceSortDefinitions
ResultDisplay	getResultDisplay()	Gets the result display
List<Returnable>	getReturnables()	Gets the Returnables
RightCheckingMode	getRightCheckingMode()	Gets the RightCheckingMode
Collection<Searchable>	getSearchables()	Gets the Searchables
String	getTitle()	Gets the title
String	getXslt()	Gets the XSLT
boolean	handleRss()	Returns true if it handles RSS
Optional<Integer>	maxResults()	Gets the maximum number of results
Optional<Integer>	resultsPerPage()	Gets the number of results per page
boolean	saveUserPrefs()	Returns true if it saves the search parameters in the user preferences
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getId

public String getId()

Gets the id

Returns:

the id

getTitle

public String getTitle()

Gets the title

Returns:

the title

getReturnables

public List<Returnable> getReturnables()

Gets the Returnables

Returns:

the Returnables

getSearchables

public Collection<Searchable> getSearchables()

Gets the Searchables

Returns:

the Searchables

getAdditionalParameters

public Collection<AdditionalSearchServiceParameter> getAdditionalParameters()

Gets the additional parameters

Returns:

the additional parameters

getAdditionalParameterValues

public AdditionalParameterValueMap getAdditionalParameterValues()

Gets the additional parameter values

Returns:

the additional parameter values

getContexts

public Collection<SearchContext> getContexts()

Gets the SearchContexts

Returns:

the SearchContexts

getCriterionTree

public Optional<AbstractTreeNode<SearchServiceCriterion<?>>> getCriterionTree()

Gets the tree of SearchServiceCriteria

Returns:

the tree of SearchServiceCriteria

computeCriteriaCounts

public boolean computeCriteriaCounts()

Returns true if the counts of enumerated criteria must be computed

Returns:

true if the counts of enumerated criteria must be computed

getFacets

public Collection<SearchServiceFacetDefinition> getFacets()

Gets the SearchServiceFacetDefinitions

Returns:

the SearchServiceFacetDefinitions

getInitialSorts

public List<Pair<SearchServiceSortDefinition,SortOrder>> getInitialSorts()

Gets the initial SearchServiceSortDefinitions with their sort order

Returns:

the initial SearchServiceSortDefinitions with their sort order

getProposedSorts

public Collection<SearchServiceSortDefinition> getProposedSorts()

Gets the proposed SearchServiceSortDefinitions

Returns:

the proposed SearchServiceSortDefinitions

resultsPerPage

public Optional<Integer> resultsPerPage()

Gets the number of results per page

Returns:

the number of results per page

maxResults

public Optional<Integer> maxResults()

Gets the maximum number of results

Returns:

the maximum number of results

getRightCheckingMode

public RightCheckingMode getRightCheckingMode()

Gets the RightCheckingMode

Returns:

the RightCheckingMode

getXslt

public String getXslt()

Gets the XSLT

Returns:

the XSLT

getResultDisplay

public ResultDisplay getResultDisplay()

Gets the result display

Returns:

the result display

getLink

public Link getLink()

Gets the link

Returns:

the link

handleRss

public boolean handleRss()

Returns true if it handles RSS

Returns:

true if it handles RSS

saveUserPrefs

public boolean saveUserPrefs()

Returns true if it saves the search parameters in the user preferences

Returns:

true if it saves the search parameters in the user preferences

toString

public String toString()

Overrides:

toString in class Object