Package org.ametys.web.frontoffice.search.metamodel

Class ReturnableEnumerator

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.ReturnableEnumerator

All Implemented Interfaces:

Enumerator<String>, Enumerator, Serviceable

public class ReturnableEnumerator
extends Object
implements Enumerator<String>, Enumerator, Serviceable

Enumerator for available and selectable Returnables

Field Summary

Fields

Modifier and Type	Field	Description
protected ReturnableExtensionPoint	_returnableEP	The extension point for Returnables

Constructor Summary

Constructors

Constructor	Description
ReturnableEnumerator()

Method Summary

Modifier and Type	Method	Description
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.
Map<String,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

_returnableEP

protected ReturnableExtensionPoint _returnableEP

The extension point for Returnables

Constructor Details

ReturnableEnumerator

public ReturnableEnumerator()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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>

Specified by:

getEntry in interface Enumerator

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

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

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration