001/*
002 *  Copyright 2012 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.runtime.parameter;
017
018import java.util.Map;
019
020import org.ametys.runtime.i18n.I18nizableText;
021
022/**
023 * Enumerator for listing values.<p>
024 * Such values usually depends on environment (directory listing, DB table, ...).
025 */
026public interface Enumerator
027{
028    /**
029     * Retrieves a single label from a value.
030     * @param value the value.
031     * @return the label or <code>null</code> if not found.
032     * @throws Exception if an error occurs.
033     */
034    public I18nizableText getEntry(String value) throws Exception;
035    
036    /**
037     * Provides the enumerated values with their optional label.
038     * @return the enumerated values and their label.
039     * @throws Exception if an error occurs.
040     */
041    public Map<Object, I18nizableText> getEntries() throws Exception;
042}