Package org.ametys.web.site

Class SiteEnumerator

java.lang.Object

org.ametys.web.site.SiteEnumerator

All Implemented Interfaces:

Enumerator<String>, Serviceable

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

Enumerates all sites. The code is the site name, the label is the site title.

Constructor Summary

Constructors

Constructor	Description
SiteEnumerator()

Method Summary

Modifier and Type	Method	Description
Map<String,I18nizableText>	getEntries()	Provides the enumerated values with their optional label.
I18nizableText	getEntry(String value)	Retrieves a single label from a value.
void	service(ServiceManager manager)

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

SiteEnumerator

public SiteEnumerator()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getEntries

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

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator<String>

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

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.