Package org.ametys.web.frontoffice.search.widgets

Class SearchServiceClientSideWidget

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.core.ui.widgets.StaticClientSideWidget

org.ametys.web.frontoffice.search.widgets.SearchServiceClientSideWidget

All Implemented Interfaces:

ClientSideElement, ClientSideWidget, LogEnabled, PluginAware, Configurable, Serviceable

public class SearchServiceClientSideWidget
extends StaticClientSideWidget

The class for search service specific widgets.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field	Description
private SearchServiceCreationHelper	_serviceCreationHelper

Fields inherited from class org.ametys.core.ui.widgets.StaticClientSideWidget

PARAMETER_FTYPES, PARAMETER_SUPPORTS_ENUMERATED, PARAMETER_SUPPORTS_MULTIPLE, PARAMETER_SUPPORTS_NONENUMERATED, PARAMETER_SUPPORTS_NONMULTIPLE

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor	Description
SearchServiceClientSideWidget()

Method Summary

Modifier and Type	Method	Description
private Map<String,Object>	_criterionDefinitionToJson(SearchCriterionDefinition criterionDefinition)
private Map<String,Object>	_facetDefinitionToJson(FacetDefinition facetDefinition)
private Map<String,Object>	_sortDefinitionToJson(SortDefinition sortDefinition)
List<Map<String,Object>>	getFacetDefinitions(List<String> returnableIds, Map<String,Object> formValues)	Gets the FacetDefinitions to display as JSON
List<Map<String,Object>>	getFacetDefinitions(Map<String,Object> parameters)	Gets the FacetDefinitions to display as JSON
Map<String,Map<String,Object>>	getSearchCriterionDefinitions(List<String> returnableIds, Map<String,Object> formValues)	Gets the SearchCriterionDefinitions to display as JSON
List<Map<String,Object>>	getSortDefinitions(List<String> returnableIds, Map<String,Object> formValues)	Gets the SortDefinitions to display as JSON
List<Map<String,Object>>	getSortDefinitions(Map<String,Object> parameters)	Gets the SortDefinitions to display as JSON
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.core.ui.widgets.StaticClientSideWidget

getFormTypes, supportsEnumerated, supportsMultiple, supportsNonEnumerated, supportsNonMultiple

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, setPluginInfo, toString

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

Methods inherited from interface org.ametys.core.ui.ClientSideElement

getDependencies, getId, getPluginName, getRights, getScripts, getScripts

Field Detail

_serviceCreationHelper

private SearchServiceCreationHelper _serviceCreationHelper

Constructor Detail

SearchServiceClientSideWidget

public SearchServiceClientSideWidget()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticFileImportsClientSideElement

Throws:

ServiceException

getSearchCriterionDefinitions

public Map<String,Map<String,Object>> getSearchCriterionDefinitions(List<String> returnableIds,
                                                                                Map<String,Object> formValues)

Gets the SearchCriterionDefinitions to display as JSON

Parameters:

returnableIds - The selected Returnables

formValues - The values of the form

Returns:

the SearchCriterionDefinitions to display as JSON

_criterionDefinitionToJson

private Map<String,Object> _criterionDefinitionToJson(SearchCriterionDefinition criterionDefinition)
                                                     throws Exception

Throws:

Exception

getFacetDefinitions

public List<Map<String,Object>> getFacetDefinitions(Map<String,Object> parameters)

Gets the FacetDefinitions to display as JSON

Parameters:

parameters - The client parameters. It must contain 'returnableIds' and 'formValues' keys.

Returns:

the FacetDefinitions to display as JSON

getFacetDefinitions

public List<Map<String,Object>> getFacetDefinitions(List<String> returnableIds,
                                                          Map<String,Object> formValues)

Gets the FacetDefinitions to display as JSON

Parameters:

returnableIds - The selected Returnables

formValues - The values of the form

Returns:

the FacetDefinitions to display as JSON

_facetDefinitionToJson

private Map<String,Object> _facetDefinitionToJson(FacetDefinition facetDefinition)

getSortDefinitions

public List<Map<String,Object>> getSortDefinitions(Map<String,Object> parameters)

Gets the SortDefinitions to display as JSON

Parameters:

parameters - The client parameters. It must contain 'returnableIds' and 'formValues' keys.

Returns:

the SortDefinitions to display as JSON

getSortDefinitions

public List<Map<String,Object>> getSortDefinitions(List<String> returnableIds,
                                                         Map<String,Object> formValues)

Gets the SortDefinitions to display as JSON

Parameters:

returnableIds - The selected Returnables

formValues - The SortDefinition of the form

Returns:

the FacetDefinitions to display as JSON

_sortDefinitionToJson

private Map<String,Object> _sortDefinitionToJson(SortDefinition sortDefinition)