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.plugins.odfweb.restrictions.rules;
017
018import org.ametys.cms.search.query.Query;
019import org.ametys.odf.program.Program;
020import org.ametys.plugins.repository.query.expression.Expression;
021
022/**
023 * Interface to represent a rule for an ODF restriction
024 */
025public interface OdfRestrictionRule
026{
027    /**
028     * Translate the restriction into an expression that can be used for repository query.
029     * @return The restriction expression
030     */
031    public Expression getExpression();
032    
033    /**
034     * Translate the restriction into a Solr query that can be used for search.
035     * @return The restriction query
036     */
037    public Query getQuery();
038    
039    /**
040     * Determines if this program is part of this restriction
041     * @param program The program
042     * @return <code>true</code> If the program is part of this restriction
043     */
044    public boolean contains(Program program);
045    
046    /**
047     * Indicate if this restriction is related to orgunit
048     * @return true if it is the case
049     */
050    public boolean hasOrgunitRestrictions(); // TODO to remove ?
051}