Package org.ametys.plugins.odfweb.restrictions

Class OrgProgramRestrictionEnumerator

java.lang.Object

org.ametys.plugins.odfweb.restrictions.OrgProgramRestrictionEnumerator

All Implemented Interfaces:

Enumerator<String>, Configurable, Serviceable

public class OrgProgramRestrictionEnumerator
extends Object
implements Enumerator<String>, Serviceable, Configurable

Enumerator for available OdfProgramRestrictions

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	_mandatory	True if a value must be selected, false to allow the empty value.
protected OdfProgramRestrictionManager	_odfProgramRestrictionManager	Odf program restriction manager

Constructor Summary

Constructors

Constructor	Description
OrgProgramRestrictionEnumerator()

Method Summary

Modifier and Type	Method	Description
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 smanager)

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 Detail

_odfProgramRestrictionManager

protected OdfProgramRestrictionManager _odfProgramRestrictionManager

Odf program restriction manager

_mandatory

protected boolean _mandatory

True if a value must be selected, false to allow the empty value.

Constructor Detail

OrgProgramRestrictionEnumerator

public OrgProgramRestrictionEnumerator()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager smanager)
             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.

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

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.