1 /* 2 * Copyright (c) 2002-2023, City of Paris 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice 10 * and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice 13 * and the following disclaimer in the documentation and/or other materials 14 * provided with the distribution. 15 * 16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its 17 * contributors may be used to endorse or promote products derived from 18 * this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 * 32 * License 1.0 33 */ 34 package fr.paris.lutece.plugins.document.business.rules; 35 36 import fr.paris.lutece.util.ReferenceList; 37 38 import java.util.Collection; 39 import java.util.Locale; 40 import java.util.Map; 41 42 /** 43 * Rule Types Sets Interface 44 */ 45 public interface IRuleTypesSet 46 { 47 /** 48 * Sets the rule types map 49 * 50 * @param mapRules 51 * The rule types map 52 */ 53 void setRuleTypesMap( Map<String, Rule> mapRules ); 54 55 /** 56 * Returns the rule types list 57 * 58 * @param locale 59 * the locale 60 * @return The rule types list 61 */ 62 ReferenceList getRuleTypesList( Locale locale ); 63 64 /** 65 * Returns the rule type of a given class type 66 * 67 * @param rule 68 * the rule 69 * @return The rule type 70 */ 71 String getRuleTypeKey( Rule rule ); 72 73 /** 74 * Create a new instance of a rule of a given type 75 * 76 * @param strRuleTypeKey 77 * The key name of the rule type 78 * @return A new Rule instance 79 */ 80 Rule newInstance( String strRuleTypeKey ); 81 82 /** 83 * Returns all rule types 84 * 85 * @return A collection of rule types 86 */ 87 Collection<Rule> getRuleTypes( ); 88 }