Package org.ametys.cms.content

Class ContentQueryEnumerator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.content.ContentQueryEnumerator

All Implemented Interfaces:

Enumerator<String>, LogEnabled, Component, Configurable, Serviceable

public class ContentQueryEnumerator
extends AbstractLogEnabled
implements Enumerator<String>, Configurable, Serviceable, Component

Enumerator of the contents matching a configured query

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysObjectResolver	The AmetysObjectResolver instance
protected List<String>	_contentTypes	The list of content types to fill enum with

Constructor Summary

Constructors

Constructor	Description
ContentQueryEnumerator()

Method Summary

Modifier and Type	Method	Description
protected List<String>	_configureContentTypes(Configuration configuration)	Configure the content type ids
void	configure(Configuration configuration)
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
void	service(ServiceManager manager)

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.runtime.model.Enumerator

getConfiguration

Field Details

_contentTypes

protected List<String> _contentTypes

The list of content types to fill enum with

_ametysObjectResolver

protected AmetysObjectResolver _ametysObjectResolver

The AmetysObjectResolver instance

Constructor Details

ContentQueryEnumerator

public ContentQueryEnumerator()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getEntry

public I18nizableText getEntry(String value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<String>

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

public Map<String,I18nizableText> getTypedEntries()
                                           throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getTypedEntries in interface Enumerator<String>

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed

_configureContentTypes

protected List<String> _configureContentTypes(Configuration configuration)
                                       throws ConfigurationException

Configure the content type ids

Parameters:

configuration - The content types configuration

Returns:

The set of content type ids

Throws:

ConfigurationException - If an error occurs