SearchServiceInstance (Ametys 4.2.x

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.

Field Summary

Fields
Modifier and Type	Field and Description
`private Collection<AdditionalSearchServiceParameter>`	`_additionalParameters`
`private AdditionalParameterValueMap`	`_additionalParameterValues`
`private boolean`	`_computeCriteriaCounts`
`private Collection<SearchContext>`	`_contexts`
`private AbstractTreeNode<FOSearchCriterion>`	`_criterionTree`
`private Collection<FacetDefinition>`	`_facets`
`private boolean`	`_handleRss`
`private String`	`_id`
`private List<Pair<SortDefinition,Sort.Order>>`	`_initialSorts`
`private Link`	`_link`
`private Integer`	`_maxResults`
`private Collection<SortDefinition>`	`_proposedSorts`
`private ResultDisplay`	`_resultDisplay`
`private Integer`	`_resultsPerPage`
`private List<Returnable>`	`_returnables`
`private RightCheckingMode`	`_rightCheckingMode`
`private boolean`	`_saveUserPrefs`
`private Collection<Searchable>`	`_searchables`
`private String`	`_title`
`private String`	`_xslt`

Constructor Summary

Constructors
Constructor and Description
SearchServiceInstance(String id, String title, List<Returnable> returnables, Collection<Searchable> searchables, Collection<AdditionalSearchServiceParameter> additionalParameters, AdditionalParameterValueMap additionalParameterValues, Collection<SearchContext> contexts, AbstractTreeNode<FOSearchCriterion> criterionTree, boolean computeCriteriaCounts, Collection<FacetDefinition> facets, List<Pair<SortDefinition,Sort.Order>> initialSorts, Collection<SortDefinition> proposedSorts, Integer resultsPerPage, Integer maxResults, RightCheckingMode rightCheckingMode, String xslt, ResultDisplay resultDisplay, Link link, boolean handleRss, boolean saveUserPrefs) Creates an instance of search service

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 `SearchContext`s
`Optional<AbstractTreeNode<FOSearchCriterion>>`	`getCriterionTree()` Gets the `tree` of `FOSearchCriteria`
`Collection<FacetDefinition>`	`getFacets()` Gets the `FacetDefinition`s
`String`	`getId()` Gets the id
`List<Pair<SortDefinition,Sort.Order>>`	`getInitialSorts()` Gets the initial `SortDefinition`s with their sort order
`Link`	`getLink()` Gets the link
`Collection<SortDefinition>`	`getProposedSorts()` Gets the proposed `SortDefinition`s
`ResultDisplay`	`getResultDisplay()` Gets the result display
`List<Returnable>`	`getReturnables()` Gets the `Returnable`s
`RightCheckingMode`	`getRightCheckingMode()` Gets the `RightCheckingMode`
`Collection<Searchable>`	`getSearchables()` Gets the `Searchable`s
`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

Field Detail

_id
```
private String _id
```

_title
```
private String _title
```

_returnables
```
private List<Returnable> _returnables
```

_searchables

private Collection<Searchable> _searchables

_additionalParameters

private Collection<AdditionalSearchServiceParameter> _additionalParameters

_additionalParameterValues

private AdditionalParameterValueMap _additionalParameterValues

_contexts

private Collection<SearchContext> _contexts

_criterionTree

private AbstractTreeNode<FOSearchCriterion> _criterionTree

_computeCriteriaCounts
```
private boolean _computeCriteriaCounts
```

_facets

private Collection<FacetDefinition> _facets

_initialSorts

private List<Pair<SortDefinition,Sort.Order>> _initialSorts

_proposedSorts

private Collection<SortDefinition> _proposedSorts

_resultsPerPage
```
private Integer _resultsPerPage
```

_maxResults
```
private Integer _maxResults
```

_rightCheckingMode

private RightCheckingMode _rightCheckingMode

_xslt
```
private String _xslt
```

_resultDisplay
```
private ResultDisplay _resultDisplay
```

_link
```
private Link _link
```

_handleRss
```
private boolean _handleRss
```

_saveUserPrefs
```
private boolean _saveUserPrefs
```

Constructor Detail

SearchServiceInstance

SearchServiceInstance(String id,
                      String title,
                      List<Returnable> returnables,
                      Collection<Searchable> searchables,
                      Collection<AdditionalSearchServiceParameter> additionalParameters,
                      AdditionalParameterValueMap additionalParameterValues,
                      Collection<SearchContext> contexts,
                      AbstractTreeNode<FOSearchCriterion> criterionTree,
                      boolean computeCriteriaCounts,
                      Collection<FacetDefinition> facets,
                      List<Pair<SortDefinition,Sort.Order>> initialSorts,
                      Collection<SortDefinition> proposedSorts,
                      Integer resultsPerPage,
                      Integer maxResults,
                      RightCheckingMode rightCheckingMode,
                      String xslt,
                      ResultDisplay resultDisplay,
                      Link link,
                      boolean handleRss,
                      boolean saveUserPrefs)

Creates an instance of search service

Parameters:: id - the id; title - the title; returnables - the returnables; searchables - the searchables; additionalParameters - the additional parameters; additionalParameterValues - the additional parameter values; contexts - the search contexts; criterionTree - the tree of criteria. Can be null if there is no criterion.; computeCriteriaCounts - true if the counts of enumerated criteria must be computed; facets - the facets; initialSorts - the initial sorts; proposedSorts - the proposed sorts; resultsPerPage - the number of results per page. Can be null; maxResults - the maximum number of results. Can be null; rightCheckingMode - the right checking mode; xslt - the XSLT; resultDisplay - the result display object; link - the link object; handleRss - true if it handles RSS; saveUserPrefs - true if it saves the search parameters in the user preferences

Method Detail
- 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<FOSearchCriterion>> getCriterionTree()
```
  Gets the tree of FOSearchCriteria
  
  Returns:
  
  the tree of FOSearchCriteria
- 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<FacetDefinition> getFacets()
```
  Gets the FacetDefinitions
  
  Returns:
  
  the FacetDefinitions
- getInitialSorts
```
public List<Pair<SortDefinition,Sort.Order>> getInitialSorts()
```
  Gets the initial SortDefinitions with their sort order
  
  Returns:
  
  the initial SortDefinitions with their sort order
- getProposedSorts
```
public Collection<SortDefinition> getProposedSorts()
```
  Gets the proposed SortDefinitions
  
  Returns:
  
  the proposed SortDefinitions
- 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

Class SearchServiceInstance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_id

_title

_returnables

_searchables

_additionalParameters

_additionalParameterValues

_contexts

_criterionTree

_computeCriteriaCounts

_facets

_initialSorts

_proposedSorts

_resultsPerPage

_maxResults

_rightCheckingMode

_xslt

_resultDisplay

_link

_handleRss

_saveUserPrefs

Constructor Detail

SearchServiceInstance

Method Detail

getId

getTitle

getReturnables

getSearchables

getAdditionalParameters

getAdditionalParameterValues

getContexts

getCriterionTree

computeCriteriaCounts

getFacets

getInitialSorts

getProposedSorts

resultsPerPage

maxResults

getRightCheckingMode

getXslt

getResultDisplay

getLink

handleRss

saveUserPrefs

toString