Package org.ametys.plugins.userdirectory.service.search

Class UserReturnable

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

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

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

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

org.ametys.plugins.userdirectory.service.search.UserReturnable

All Implemented Interfaces:

LogEnabled, PluginAware, Returnable, Initializable, Configurable, Contextualizable, Serviceable

public class UserReturnable
extends PrivateContentReturnable

The returnable for User

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UserReturnable.UserSaxer	The ReturnableSaxer for user contents.

Field Summary

Fields

Modifier and Type	Field	Description
protected ContentTypeExtensionPoint	_contentTypeExtensionPoint	The content type extension point
protected ContentTypesHelper	_contentTypeHelper	The helper for content types
protected PageReturnable	_pageReturnable	The returnable for pages.
protected UserDirectoryPageResolver	_userDirectoryPageResolver	The resolver for user directory virtual pages

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentReturnable

_associatedContentSearchableRole, _avalonRole, _definitionPrefix, _shortAvalonRole

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable

_associatedContentSearchable, _contentFilterHelper, _contentHelper, _context, _label, _searchableEP

Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

_manager, _pluginName

Constructor Summary

Constructors

Constructor	Description
UserReturnable()

Method Summary

Modifier and Type	Method	Description
ReturnableSaxer	getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues)	Returns the saxer responsible to SAX hits of this Returnable.
void	service(ServiceManager manager)
protected Function<Query,Query>	siteQueryJoiner()	The joiner for the site query

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.PrivateContentReturnable

_configureAssociatedContentReturnableRole, _getAssociatedSearchable, _initAvalonRole, _initDefinitionPrefix, _initShortAvalonRole, associatedContentSearchableRole, configure, getContentTypes, getDefinitionPrefix, getId, getViewForSax

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable

_setAssociatedContentSearchable, contextualize, filterReturnedDocumentQuery, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, sitemapQueryJoiner, tagQueryJoiner

Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder

additionalServiceParameters, setPluginInfo

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

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, selectedByDefault

Field Detail

_pageReturnable

protected PageReturnable _pageReturnable

The returnable for pages. Only used because UserReturnable.UserSaxer extends PageSaxer whose constructor needs it.

_contentTypeHelper

protected ContentTypesHelper _contentTypeHelper

The helper for content types

_contentTypeExtensionPoint

protected ContentTypeExtensionPoint _contentTypeExtensionPoint

The content type extension point

_userDirectoryPageResolver

protected UserDirectoryPageResolver _userDirectoryPageResolver

The resolver for user directory virtual pages

Constructor Detail

UserReturnable

public UserReturnable()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentBasedReturnable

Throws:

ServiceException

siteQueryJoiner

protected Function<Query,Query> siteQueryJoiner()

Description copied from class: AbstractContentBasedReturnable

The joiner for the site query

Overrides:

siteQueryJoiner in class AbstractContentBasedReturnable

Returns:

The joiner for the site query

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

Overrides:

getSaxer in class PrivateContentReturnable

Parameters:

allReturnables - All Returnables (including this)

additionalParameterValues - The additional parameter values

Returns:

the saxer responsible to SAX hits of this Returnable.