001/*
002 *  Copyright 2019 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.web.frontoffice.search.metamodel;
017
018import java.util.List;
019import java.util.Map;
020
021import org.ametys.runtime.i18n.I18nizableText;
022
023/**
024 * Represents some enumerated values returned by {@link SearchCriterionDefinition#getEnumeratedValues}
025 */
026public interface EnumeratedValues
027{
028    /**
029     * Gets all the values (with their label)
030     * @return all the values (with their label)
031     */
032    Map<Object, I18nizableText> getAllValues();
033    
034    /**
035     * Gets the {@link RestrictedValues} object
036     * <br>The implementation must decide whether or not the given objs must be validated among {@link #getAllValues all values}, if they must be converted, etc.
037     * @param objs The desired objects
038     * @return the {@link RestrictedValues}
039     */
040    RestrictedValues getRestrictedValuesFor(List<Object> objs);
041    
042    /**
043     * Represents a subset of values (some 'restricted' values) of a given {@link EnumeratedValues}.
044     */
045    interface RestrictedValues
046    {
047        Map<Object, I18nizableText> values();
048    }
049}
050