001/*
002 *  Copyright 2018 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.Map;
019import java.util.Optional;
020
021import org.ametys.cms.search.solr.SearcherFactory.FacetDefinition;
022import org.ametys.runtime.i18n.I18nizableText;
023import org.ametys.runtime.util.Labelable;
024
025/**
026 * A potential facet proposed to the creator of an instance of search service.
027 */
028public interface SearchServiceFacetDefinition extends Labelable
029{
030    /**
031     * Retrieves the facet definition
032     * @return the facet definition
033     */
034    FacetDefinition getFacetDefinition();
035    
036    /**
037     * Gets the label of a facet value
038     * @param value the facet value
039     * @param contextualParameters the contextual parameters
040     * @return the label of a facet value
041     */
042    Optional<I18nizableText> getFacetLabel(String value, Map<String, Object> contextualParameters);
043    
044    /**
045     * Gets the ({@link Returnable}) the facet belongs to.
046     * @return the ({@link Returnable}) the facet belongs to.
047     */
048    Optional<Returnable> getReturnable();
049}