Package org.ametys.odf.orgunit

Class OrgUnitEnumerator

java.lang.Object

org.ametys.odf.orgunit.OrgUnitEnumerator

All Implemented Interfaces:

Enumerator<String>, Enumerator, Configurable, Serviceable

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

Enumerator for OrgUnits

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_allOption	All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' option
protected boolean	_mandatory	True if a value must be selected, false to allow the empty value.
protected RootOrgUnitProvider	_orgUnitProvider	The OrgUnit root provider
protected AmetysObjectResolver	_resolver	The Ametys object resolver

Constructor Summary

Constructors

Constructor	Description
OrgUnitEnumerator()

Method Summary

Modifier and Type	Method	Description
private Map<String,I18nizableText>	_getSubOrgUnits(OrgUnit orgUnit)
void	configure(Configuration configuration)
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 smanager)

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

_orgUnitProvider

protected RootOrgUnitProvider _orgUnitProvider

The OrgUnit root provider

_mandatory

protected boolean _mandatory

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

_allOption

protected String _allOption

All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' option

Constructor Detail

OrgUnitEnumerator

public OrgUnitEnumerator()

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

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.

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

_getSubOrgUnits

private Map<String,I18nizableText> _getSubOrgUnits(OrgUnit orgUnit)

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.

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