001/*
002 *  Copyright 2017 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.cms.search;
017
018/**
019 * Represents a search field which can be joined.
020 */
021public interface JoinableSearchField extends SearchField
022{
023    /**
024     * Indicates if the search field is joined
025     * @return <code>true</code> if the search field is joined
026     */
027    boolean isJoined();
028    
029    /**
030     * Gets the joined path (separated by '-&gt;')
031     * @return the joined path (separated by '-&gt;')
032     */
033    String getJoinedPath();
034    
035    /**
036     * Get the facet function corresponding to this field.
037     * @return The facet function.
038     */
039    String getFacetFunction();
040}