Class ProgramSearchable
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdderSearchable
org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedSearchable
org.ametys.plugins.odfweb.service.search.ProgramSearchable
- All Implemented Interfaces:
Cacheable
,LogEnabled
,PluginAware
,Searchable
,Disposable
,Initializable
,Configurable
,Contextualizable
,Serviceable
Searchable
for Program
s-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
AQuery
that returns Programs, by querying their child ProgramPartsNested classes/interfaces inherited from interface org.ametys.core.util.Cacheable
Cacheable.SingleCacheConfiguration
-
Field Summary
Modifier and TypeFieldDescriptionprotected ODFSearchHelper
The ODF search helperstatic final String
The additional parameter for indicating if search has to be made also on subprogramsstatic final String
Avalon RoleFields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedSearchable
_associatedContentReturnable, _criteriaPosition, _cTypeEP, _label, _pageReturnable
Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
_manager, _pluginName
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
appliesToSubprogram
(SearchCriterionDefinition criterion) Determines if the givenSearchCriterionDefinition
applies to Subprogramsprotected String
The Avalon Role for the associated Content Returnableprotected Collection<String>
getContentTypes
(AdditionalParameterValueMap additionalParameterValues) Gets the content types which will be used to retrieve the criteria relative to the Indexing Modelprotected String
Gets the prefix for criterion definitionsprotected Query
getProgramThroughSubprogramsQuery
(Query queryOnCriterion) Gets theQuery
that returns Programs by querying their SubProgramsjoinQuery
(Query queryOnCriterion, SearchCriterionDefinition criterion, Collection<Returnable> returnables, AdditionalParameterValueMap additionalParameters) Returns the query which joins the given one (on a criterion) with the given result typesRetrieves the relations the type must have with someReturnable
s.void
service
(ServiceManager manager) Methods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedSearchable
_setAssociatedContentReturnable, configure, contextualize, criteriaPosition, dispose, getCacheManager, getCriteria, getIndexingFieldCriterionDefinitionPrefix, getLabel, getManagedCaches, getSystemPropertyCriterionDefinitionPrefix, hasComputableSize, initialize
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.core.util.Cacheable
createCaches, getCache, isCachingEnabled, removeCaches
Methods inherited from interface org.ametys.web.frontoffice.search.metamodel.Searchable
additionalServiceParameters
-
Field Details
-
ROLE
Avalon Role -
PARAMETER_SEARCH_ON_SUBPROGRAMS
The additional parameter for indicating if search has to be made also on subprograms- See Also:
-
_odfSearchHelper
The ODF search helper
-
-
Constructor Details
-
ProgramSearchable
public ProgramSearchable()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractContentBasedSearchable
- Throws:
ServiceException
-
associatedContentReturnableRole
Description copied from class:AbstractContentBasedSearchable
The Avalon Role for the associated Content Returnable- Specified by:
associatedContentReturnableRole
in classAbstractContentBasedSearchable
- Returns:
- The Avalon Role for the associated Content Returnable
-
getCriterionDefinitionPrefix
Description copied from class:AbstractContentBasedSearchable
Gets the prefix for criterion definitions- Specified by:
getCriterionDefinitionPrefix
in classAbstractContentBasedSearchable
- Returns:
- the prefix for criterion definitions
-
relationsWith
Description copied from interface:Searchable
Retrieves the relations the type must have with someReturnable
s.
It does not have to be exhaustive (for instance ifReturnable.relationsWith()
declares the relation, it is useless to declare it twice)- Specified by:
relationsWith
in interfaceSearchable
- Overrides:
relationsWith
in classAbstractContentBasedSearchable
- Returns:
- some relations the type must have with some
Returnable
s
-
getContentTypes
Description copied from class:AbstractContentBasedSearchable
Gets the content types which will be used to retrieve the criteria relative to the Indexing Model- Specified by:
getContentTypes
in classAbstractContentBasedSearchable
- Parameters:
additionalParameterValues
- The additional parameter values- Returns:
- the content types which will be used to retrieve the criteria relative to the Indexing Model
-
joinQuery
public Optional<Query> joinQuery(Query queryOnCriterion, SearchCriterionDefinition criterion, Collection<Returnable> returnables, AdditionalParameterValueMap additionalParameters) Description copied from interface:Searchable
Returns the query which joins the given one (on a criterion) with the given result types- Parameters:
queryOnCriterion
- The query on the criterion to join fromcriterion
- the criterionreturnables
- The returnables to join toadditionalParameters
- The additional parameters- Returns:
- the joined query
-
appliesToSubprogram
Determines if the givenSearchCriterionDefinition
applies to Subprograms- Parameters:
criterion
- the criterion- Returns:
true
if the givenSearchCriterionDefinition
applies to Subprograms
-
getProgramThroughSubprogramsQuery
Gets theQuery
that returns Programs by querying their SubPrograms- Parameters:
queryOnCriterion
- The query on SubPrograms- Returns:
- The
Query
that returns Programs
-