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

Class SearchServiceCriterionDefinitionHelper

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.SearchServiceCriterionDefinitionHelper

All Implemented Interfaces:

Component

public class SearchServiceCriterionDefinitionHelper
extends Object
implements Component

Helper for SearchServiceCriterionDefinition

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The component role.

Constructor Summary

Constructors

Constructor	Description
SearchServiceCriterionDefinitionHelper()

Method Summary

Modifier and Type	Method	Description
SearchServiceCriterionDefinition	createReferencingSearchServiceCriterionDefinition(String criterionDefinitionName, ElementDefinition reference, String referencePath, Searchable searchable, String pluginName)	Retrieves a SearchServiceCriterionDefinition referencing the given definition
SearchServiceCriterionDefinition	createReferencingSearchServiceCriterionDefinition(String criterionDefinitionName, ElementDefinition reference, String referencePath, Searchable searchable, ContentType contentType, String pluginName)	Retrieves a SearchServiceCriterionDefinition referencing the given definition
<T> Map<String,Object>	getDefaultSearchServiceCriterionDefinitionJSON(SearchServiceCriterionDefinition<T> criterionDefinition, boolean isTooBigForStaticEnumerator)	Retrieves the default values to put in a Criterion definition JSON

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The component role.

Constructor Details

SearchServiceCriterionDefinitionHelper

public SearchServiceCriterionDefinitionHelper()

Method Details

createReferencingSearchServiceCriterionDefinition

public SearchServiceCriterionDefinition createReferencingSearchServiceCriterionDefinition(String criterionDefinitionName,
 ElementDefinition reference,
 String referencePath,
 Searchable searchable,
 String pluginName)

Retrieves a SearchServiceCriterionDefinition referencing the given definition

Parameters:

criterionDefinitionName - the name of the criterion definition to create

reference - the definition of the element to reference

referencePath - the path of the reference from the model containing the reference

searchable - the (Searchable) the criterion belongs to

pluginName - the name of the plugin declaring the criterion definition

Returns:

the SearchServiceCriterionDefinition

createReferencingSearchServiceCriterionDefinition

public SearchServiceCriterionDefinition createReferencingSearchServiceCriterionDefinition(String criterionDefinitionName,
 ElementDefinition reference,
 String referencePath,
 Searchable searchable,
 ContentType contentType,
 String pluginName)

Retrieves a SearchServiceCriterionDefinition referencing the given definition

Parameters:

criterionDefinitionName - the name of the criterion definition to create

reference - the definition of the element to reference

referencePath - the path of the reference from the model containing the reference

searchable - the (Searchable) the criterion belongs to

contentType - the content type defining the reference

pluginName - the name of the plugin declaring the criterion definition

Returns:

the SearchServiceCriterionDefinition

getDefaultSearchServiceCriterionDefinitionJSON

public <T> Map<String,Object> getDefaultSearchServiceCriterionDefinitionJSON(SearchServiceCriterionDefinition<T> criterionDefinition,
 boolean isTooBigForStaticEnumerator)

Retrieves the default values to put in a Criterion definition JSON

Type Parameters:

T - Type of the criterion definition

Parameters:

criterionDefinition - the criterion definition

isTooBigForStaticEnumerator - true if the criterion definition can contain too much data

Returns:

the default values to put in a Criterion definition JSON