All Known Implementing Classes:

AbstractContentBasedReturnable, AbstractParameterAdderReturnable, ContentReturnable, CourseReturnable, PageReturnable, PrivateContentReturnable, ProgramReturnable, ResourceReturnable, UserReturnable
```
public interface Returnable
```
Brings a type of objects returned by the search service.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Collection<Configuration>`	`additionalServiceParameters()`	Retrieves the additional parameters to add to the search service The ids of the parameters must be unique across all `Returnable`s and `Searchable`s
`Query`	`filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers, AdditionalParameterValueMap additionalParameterValues)`	Returns the query to execute in order to filter returned objects (according to their type) during the search.
`Collection<FacetDefinition>`	`getFacets(AdditionalParameterValueMap additionalParameterValues)`	Gets the facets
`String`	`getId()`	Gets the id of the extension
`I18nizableText`	`getLabel()`	Gets the label of the type of result
`ReturnableSaxer`	`getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues)`	Returns the `saxer` responsible to SAX hits of this Returnable.
`Collection<SortDefinition>`	`getSorts(AdditionalParameterValueMap additionalParameterValues)`	Gets the sorts
`default Collection<Searchable>`	`relationsWith()`	Retrieves the relations the type must have with some `Searchable`s.
`default boolean`	`selectedByDefault()`	Returns `true` if the type must be selected by default

- Method Detail
  - getId
```
String getId()
```
    Gets the id of the extension
    
    Returns:
    
    the id of the extension
  - getLabel
```
I18nizableText getLabel()
```
    Gets the label of the type of result
    
    Returns:
    
    the label of the type of result
  - selectedByDefault
```
default boolean selectedByDefault()
```
    Returns true if the type must be selected by default
    
    Returns:
    
    true if the type must be selected by default
  - relationsWith
```
default Collection<Searchable> relationsWith()
```
    Retrieves the relations the type must have with some Searchables.
    It does not have to be exhaustive (for instance if Searchable.relationsWith() declares the relation, it is useless to declare it twice)
    
    Returns:
    
    some relations the type must have with some Searchables
  - additionalServiceParameters
```
default Collection<Configuration> additionalServiceParameters()
```
    Retrieves the additional parameters to add to the search service
    The ids of the parameters must be unique across all Returnables and Searchables
    
    Returns:
    
    some additional parameters to add to the search service
  - filterReturnedDocumentQuery
```
Query filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers,
                                  AdditionalParameterValueMap additionalParameterValues)
```
    Returns the query to execute in order to filter returned objects (according to their type) during the search.
    It should call ContextQueriesWrapper#getQuery in order to make a JoinQuery on interesting parts of ContextQueriesWrappers and then constructs an AndQuery composed of a DocumentTypeQuery and the result of the call.
    
    Parameters:
    
    contextQueriesWrappers - The context queries
    
    additionalParameterValues - The additional parameter values
    
    Returns:
    
    the query to execute in order to filter returned objects (according to their type) during the search.
  - getSaxer
```
ReturnableSaxer getSaxer(Collection<Returnable> allReturnables,
                         AdditionalParameterValueMap additionalParameterValues)
```
    Returns the saxer responsible to SAX hits of this Returnable.
    
    Parameters:
    
    allReturnables - All Returnables (including this)
    
    additionalParameterValues - The additional parameter values
    
    Returns:
    
    the saxer responsible to SAX hits of this Returnable.
  - getFacets
```
Collection<FacetDefinition> getFacets(AdditionalParameterValueMap additionalParameterValues)
```
    Gets the facets
    
    Parameters:
    
    additionalParameterValues - The additional parameter values
    
    Returns:
    
    the facets
  - getSorts
```
Collection<SortDefinition> getSorts(AdditionalParameterValueMap additionalParameterValues)
```
    Gets the sorts
    
    Parameters:
    
    additionalParameterValues - The additional parameter values
    
    Returns:
    
    the sorts

Interface Returnable

Method Summary

Method Detail

getId

getLabel

selectedByDefault

relationsWith

additionalServiceParameters

filterReturnedDocumentQuery

getSaxer

getFacets

getSorts