View Javadoc
1   /*
2    * Copyright (c) 2002-2020, 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  /**
44   * Rule Types Sets Interface
45   */
46  public interface IRuleTypesSet
47  {
48      /**
49       * Sets the rule types map
50       * @param mapRules The rule types map
51       */
52      void setRuleTypesMap( Map<String, Rule> mapRules );
53  
54      /**
55       * Returns the rule types list
56       * @param locale the locale
57       * @return The rule types list
58       */
59      ReferenceList getRuleTypesList( Locale locale );
60  
61      /**
62       * Returns the rule type of a given class type
63       * @param rule the rule
64       * @return The rule type
65       */
66      String getRuleTypeKey( Rule rule );
67  
68      /**
69       * Create a new instance of a rule of a given type
70       * @param strRuleTypeKey The key name of the rule type
71       * @return A new Rule instance
72       */
73      Rule newInstance( String strRuleTypeKey );
74  
75      /**
76       * Returns all rule types
77       * @return A collection of rule types
78       */
79      Collection<Rule> getRuleTypes(  );
80  }