Package org.ametys.plugins.odfpilotage.enumerators

Class StepHolderEnumerator

java.lang.Object

org.ametys.plugins.odfpilotage.enumerators.StepHolderEnumerator

All Implemented Interfaces:

Enumerator<ContentValue>, Enumerator, Configurable, Contextualizable, Serviceable

public class StepHolderEnumerator
extends Object
implements Enumerator<ContentValue>, Serviceable, Contextualizable, Configurable, Enumerator

Enumerator for the steps holder

Constructor Summary

Constructors

Constructor	Description
StepHolderEnumerator()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
void	contextualize(Context context)
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.
I18nizableText	getEntry(ContentValue value)	Retrieves a single label from a value.
Map<ContentValue,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

Constructor Details

StepHolderEnumerator

public StepHolderEnumerator()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getEntry

public I18nizableText getEntry(ContentValue value)
                        throws Exception

Description copied from interface: Enumerator

Retrieves a single label from a value.

Specified by:

getEntry in interface Enumerator<ContentValue>

Parameters:

value - the value.

Returns:

the label or null if not found.

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

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

public Map<ContentValue,I18nizableText> getTypedEntries()
                                                 throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getTypedEntries in interface Enumerator<ContentValue>

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

Specified by:

getConfiguration in interface Enumerator

Returns:

the configuration