001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search.facet;
016    
017    import com.liferay.portal.kernel.search.BooleanClause;
018    import com.liferay.portal.kernel.search.Query;
019    import com.liferay.portal.kernel.search.SearchContext;
020    import com.liferay.portal.kernel.search.facet.collector.FacetCollector;
021    import com.liferay.portal.kernel.search.facet.config.FacetConfiguration;
022    import com.liferay.portal.kernel.search.facet.util.FacetValueValidator;
023    import com.liferay.portal.kernel.search.filter.Filter;
024    
025    /**
026     * @author Raymond Aug??
027     */
028    public interface Facet {
029    
030            /**
031             * @deprecated As of 7.0.0, replaced by {@link #getFacetFilterBooleanClause}
032             */
033            @Deprecated
034            public BooleanClause<Query> getFacetClause();
035    
036            public FacetCollector getFacetCollector();
037    
038            public FacetConfiguration getFacetConfiguration();
039    
040            public BooleanClause<Filter> getFacetFilterBooleanClause();
041    
042            public FacetValueValidator getFacetValueValidator();
043    
044            public String getFieldId();
045    
046            public String getFieldName();
047    
048            public SearchContext getSearchContext();
049    
050            public boolean isStatic();
051    
052            public void setFacetCollector(FacetCollector facetCollector);
053    
054            public void setFacetConfiguration(FacetConfiguration facetConfiguration);
055    
056            public void setFacetValueValidator(FacetValueValidator facetValueValidator);
057    
058            public void setFieldName(String fieldName);
059    
060            public void setStatic(boolean isStatic);
061    
062    }