Package org.ametys.plugins.workspaces.project.enumerators

Class ProjectPopulationEnumerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.workspaces.project.enumerators.ProjectPopulationEnumerator

All Implemented Interfaces:

Enumerator<String>, Contextualizable, LogEnabled, Serviceable

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

Enumerator for the populations available to a project

Constructor Summary

Constructors

Constructor	Description
ProjectPopulationEnumerator()

Method Summary

Modifier and Type	Method	Description
void	contextualize(Context context)
I18nizableText	getEntry(String code)	Retrieves a single label from a value.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
void	service(ServiceManager serviceManager)

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

Methods inherited from interface org.ametys.runtime.model.Enumerator

getConfiguration

Constructor Details

ProjectPopulationEnumerator

public ProjectPopulationEnumerator()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

getEntry

public I18nizableText getEntry(String code)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<String>

Parameters:

code - 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