Package org.ametys.web.frontoffice.search.metamodel.impl

Class PageReturnable

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.impl.PageReturnable

All Implemented Interfaces:

Returnable, Configurable, Serviceable

public class PageReturnable
extends Object
implements Returnable, Serviceable, Configurable

Returnable for Pages

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	__PREFIX_ID	The prefix for the ids of facets and sorts
protected ContentHelper	_contentHelper	The helper to handler contents
protected Returnable	_contentReturnable	The content returnable
protected ContentTypesHelper	_contentTypesHelper	The helper to handler content types
protected I18nizableText	_label	The label
protected ServiceManager	_manager	The service manager.
protected ReturnableSaxer	_saxer	The saxer
protected SiteManager	_siteManager	The sites manager
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
PageReturnable()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
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
boolean	selectedByDefault()	Returns true if the type must be selected by default
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.Returnable

additionalServiceParameters, relationsWith

Field Details

ROLE

public static final String ROLE

Avalon Role

__PREFIX_ID

protected static final String __PREFIX_ID

The prefix for the ids of facets and sorts

See Also:

• Constant Field Values

_siteManager

protected SiteManager _siteManager

The sites manager

_contentReturnable

protected Returnable _contentReturnable

The content returnable

_contentTypesHelper

protected ContentTypesHelper _contentTypesHelper

The helper to handler content types

_contentHelper

protected ContentHelper _contentHelper

The helper to handler contents

_manager

protected ServiceManager _manager

The service manager.

_label

protected I18nizableText _label

The label

_saxer

protected ReturnableSaxer _saxer

The saxer

Constructor Details

PageReturnable

public PageReturnable()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getId

public String getId()

Description copied from interface: Returnable

Gets the id of the extension

Specified by:

getId in interface Returnable

Returns:

the id of the extension

getLabel

public I18nizableText getLabel()

Description copied from interface: Returnable

Gets the label of the type of result

Specified by:

getLabel in interface Returnable

Returns:

the label of the type of result

selectedByDefault

public boolean selectedByDefault()

Description copied from interface: Returnable

Returns true if the type must be selected by default

Specified by:

selectedByDefault in interface Returnable

Returns:

true if the type must be selected by default

filterReturnedDocumentQuery

public Query filterReturnedDocumentQuery(Collection<ContextQueriesWrapper> contextQueriesWrappers,
 AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

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.

Specified by:

filterReturnedDocumentQuery in interface Returnable

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

public ReturnableSaxer getSaxer(Collection<Returnable> allReturnables,
 AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Returns the saxer responsible to SAX hits of this Returnable.

Specified by:

getSaxer in interface Returnable

Parameters:

allReturnables - All Returnables (including this)

additionalParameterValues - The additional parameter values

Returns:

the saxer responsible to SAX hits of this Returnable.

getFacets

public Collection<FacetDefinition> getFacets(AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Gets the facets

Specified by:

getFacets in interface Returnable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the facets

getSorts

public Collection<SortDefinition> getSorts(AdditionalParameterValueMap additionalParameterValues)

Description copied from interface: Returnable

Gets the sorts

Specified by:

getSorts in interface Returnable

Parameters:

additionalParameterValues - The additional parameter values

Returns:

the sorts