Package org.ametys.plugins.odfweb.service.search

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

public class ProgramReturnable
extends AbstractContentBasedReturnable

Returnable for Programs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	ProgramReturnable.DisplaySubprogramMode

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	__PREFIX_ID	The prefix for the ids of sorts
(package private) Context	_avalonContext	The context
private ContentTypeExtensionPoint	_cTypeEP
private OdfPageResolver	_odfPageResolver
private PageReturnable	_pageReturnable
private ReturnableExtensionPoint	_returnableEP
static String	PARAMETER_DISPLAY_SUBPROGRAMS	The additional parameter for indicating how subprograms are displayed
static String	ROLE	Avalon Role

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
ProgramReturnable()

Method Summary

Modifier and Type	Method	Description
protected PageReturnable	_gePageReturnable()	Get the Returnable for page
protected ContentTypeExtensionPoint	_getContentTypeEP()	Get the ContentTypeExtensionPoint
protected OdfPageResolver	_getOdfPageResolver()	Get the ODF page resolver
protected String	associatedContentSearchableRole()	The Avalon Role for the associated Content Searchable
void	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 documents
protected String	getDefinitionPrefix()	Gets the prefix for definitions (for facets, sorts...)
(package private) static ProgramReturnable.DisplaySubprogramMode	getDisplaySubprogramMode(AdditionalParameterValueMap additionalParameterValues)
String	getId()	Gets the id of the extension
ReturnableSaxer	getSaxer(Collection<Returnable> allReturnables, AdditionalParameterValueMap additionalParameterValues)	Returns the saxer responsible to SAX hits of this Returnable.
void	service(ServiceManager manager)

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

_setAssociatedContentSearchable, configure, filterReturnedDocumentQuery, getFacets, getLabel, getSorts, initialize, langQueryProducer, relationsWith, sitemapQueryJoiner, siteQueryJoiner, 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

ROLE

public static final String ROLE

Avalon Role

PARAMETER_DISPLAY_SUBPROGRAMS

public static final String PARAMETER_DISPLAY_SUBPROGRAMS

The additional parameter for indicating how subprograms are displayed

See Also:

Constant Field Values

__PREFIX_ID

protected static final String __PREFIX_ID

The prefix for the ids of sorts

See Also:

Constant Field Values

_avalonContext

Context _avalonContext

The context

_odfPageResolver

private OdfPageResolver _odfPageResolver

_cTypeEP

private ContentTypeExtensionPoint _cTypeEP

_returnableEP

private ReturnableExtensionPoint _returnableEP

_pageReturnable

private PageReturnable _pageReturnable

Constructor Detail

ProgramReturnable

public ProgramReturnable()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractContentBasedReturnable

Throws:

ServiceException

_getOdfPageResolver

protected OdfPageResolver _getOdfPageResolver()

Get the ODF page resolver

Returns:

the ODF page resolver

_getContentTypeEP

protected ContentTypeExtensionPoint _getContentTypeEP()

Get the ContentTypeExtensionPoint

Returns:

the ContentTypeExtensionPoint

_gePageReturnable

protected PageReturnable _gePageReturnable()

Get the Returnable for page

Returns:

the PageReturnable

associatedContentSearchableRole

protected String associatedContentSearchableRole()

Description copied from class: AbstractContentBasedReturnable

The Avalon Role for the associated Content Searchable

Specified by:

associatedContentSearchableRole in class AbstractContentBasedReturnable

Returns:

The Avalon Role for the associated Content Searchable

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Overrides:

contextualize in class AbstractContentBasedReturnable

Throws:

ContextException

getId

public String getId()

Description copied from interface: Returnable

Gets the id of the extension

Returns:

the id of the extension

getContentTypes

protected Collection<String> getContentTypes(AdditionalParameterValueMap additionalParameterValues)

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 class AbstractContentBasedReturnable

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 the saxer responsible to SAX hits of this Returnable.

Parameters:

allReturnables - All Returnables (including this)

additionalParameterValues - The additional parameter values

Returns:

the saxer responsible to SAX hits of this Returnable.

getDisplaySubprogramMode

static ProgramReturnable.DisplaySubprogramMode getDisplaySubprogramMode(AdditionalParameterValueMap additionalParameterValues)

getDefinitionPrefix

protected String getDefinitionPrefix()

Description copied from class: AbstractContentBasedReturnable

Gets the prefix for definitions (for facets, sorts...)

Specified by:

getDefinitionPrefix in class AbstractContentBasedReturnable

Returns:

the prefix for definitions