Class ProgramReturnable
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.plugins.odfweb.service.search.ProgramReturnable
- All Implemented Interfaces:
LogEnabled
,PluginAware
,Returnable
,Initializable
,Configurable
,Contextualizable
,Serviceable
Returnable
for Program
s-
Field Summary
Modifier and TypeFieldDescriptionprotected static final String
The prefix for the ids of sortsstatic final String
The additional parameter for indicating how subprograms are displayedstatic final String
Avalon RoleFields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
_associatedContentSearchable, _contentFilterHelper, _contentHelper, _contentTypesHelper, _context, _label, _searchableEP
Fields inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractParameterAdder
_manager, _pluginName
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected PageReturnable
Get theReturnable
for pageprotected ContentTypeExtensionPoint
Get theContentTypeExtensionPoint
protected OdfPageResolver
Get the ODF page resolverprotected String
The Avalon Role for the associated Content Searchablevoid
contextualize
(Context context) protected Collection<String>
getContentTypes
(AdditionalParameterValueMap additionalParameterValues) Gets the content types which will be used to construct the query to filter the returned documentsprotected String
Gets the prefix for definitions (for facets, sorts...)getId()
Gets the id of the extensiongetSaxer
(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues) Returns thesaxer
responsible to SAX hits of this Returnable.void
service
(ServiceManager manager) The joiner for the site queryMethods inherited from class org.ametys.web.frontoffice.search.metamodel.impl.AbstractContentBasedReturnable
_setAssociatedContentSearchable, configure, 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 Details
-
ROLE
Avalon Role -
PARAMETER_DISPLAY_SUBPROGRAMS
The additional parameter for indicating how subprograms are displayed- See Also:
-
__PREFIX_ID
The prefix for the ids of sorts- See Also:
-
-
Constructor Details
-
ProgramReturnable
public ProgramReturnable()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Overrides:
service
in classAbstractContentBasedReturnable
- Throws:
ServiceException
-
siteQueryJoiner
Description copied from class:AbstractContentBasedReturnable
The joiner for the site query- Overrides:
siteQueryJoiner
in classAbstractContentBasedReturnable
- Returns:
- The joiner for the site query
-
_getOdfPageResolver
Get the ODF page resolver- Returns:
- the ODF page resolver
-
_getContentTypeEP
Get theContentTypeExtensionPoint
- Returns:
- the
ContentTypeExtensionPoint
-
_gePageReturnable
Get theReturnable
for page- Returns:
- the
PageReturnable
-
associatedContentSearchableRole
Description copied from class:AbstractContentBasedReturnable
The Avalon Role for the associated Content Searchable- Specified by:
associatedContentSearchableRole
in classAbstractContentBasedReturnable
- Returns:
- The Avalon Role for the associated Content Searchable
-
contextualize
- Specified by:
contextualize
in interfaceContextualizable
- Overrides:
contextualize
in classAbstractContentBasedReturnable
- Throws:
ContextException
-
getId
Description copied from interface:Returnable
Gets the id of the extension- Returns:
- the id of the extension
-
getContentTypes
Description copied from class:AbstractContentBasedReturnable
Gets the content types which will be used to construct the query to filter the returned documents- Specified by:
getContentTypes
in classAbstractContentBasedReturnable
- Parameters:
additionalParameterValues
- The additional parameter values- Returns:
- the content types which will be used to construct the query to filter the returned documents
-
getSaxer
public ReturnableSaxer getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues) Description copied from interface:Returnable
Returns thesaxer
responsible to SAX hits of this Returnable.- Parameters:
allReturnables
- AllReturnable
s (including this)additionalParameterValues
- The additional parameter values- Returns:
- the
saxer
responsible to SAX hits of this Returnable.
-
getDefinitionPrefix
Description copied from class:AbstractContentBasedReturnable
Gets the prefix for definitions (for facets, sorts...)- Specified by:
getDefinitionPrefix
in classAbstractContentBasedReturnable
- Returns:
- the prefix for definitions
-