org.ametys.plugins.survey.repository

Class SurveyEnumerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.survey.repository.SurveyEnumerator

All Implemented Interfaces:

Enumerator, Contextualizable, LogEnabled, Serviceable

public class SurveyEnumerator
extends AbstractLogEnabled
implements Enumerator<String>, Enumerator, Serviceable, Contextualizable

Enumerates existing surveys.

Field Summary

Fields

Modifier and Type	Field and Description
private Context	_context
protected AmetysObjectResolver	_resolver The ametys object resolver.
protected SiteManager	_siteManager The site manager.

Constructor Summary

Constructors

Constructor and Description
SurveyEnumerator()

Method Summary

Modifier and Type	Method and Description
void	contextualize(Context context)
Map<String,Object>	getConfiguration() Get the configuration of this enumerator
Map<Object,I18nizableText>	getEntries() Provides the enumerated values with their optional label.
I18nizableText	getEntry(String value) Retrieves a single label from a value.
protected ModifiableTraversableAmetysObject	getSurveyRootNode(String siteName, String lang) Get the root node for surveys
Map<String,I18nizableText>	getTypedEntries() Provides the enumerated values with their optional label.
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver.

_siteManager

protected SiteManager _siteManager

The site manager.

_context

private Context _context

Constructor Detail

SurveyEnumerator

public SurveyEnumerator()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getTypedEntries

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

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Returns:

the enumerated values and their label.

Throws:

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

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

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getSurveyRootNode

protected ModifiableTraversableAmetysObject getSurveyRootNode(String siteName,
                                                              String lang)
                                                       throws RepositoryException

Get the root node for surveys

Parameters:

siteName - the site name

lang - the language

Returns:

the root node

Throws:

RepositoryException - if an error occurs when retrieving the root node of the survey

getEntries

public Map<Object,I18nizableText> getEntries()
                                      throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getConfiguration

public Map<String,Object> getConfiguration()

Description copied from interface: Enumerator

Get the configuration of this enumerator

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration