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 java.util.List;
37
38 /**
39 * Rule DAO Interface
40 */
41 public interface IRuleDAO
42 {
43 /**
44 * Delete a record from the table
45 *
46 * @param nRuleId
47 * The Rule Id
48 */
49 void delete( int nRuleId );
50
51 /**
52 * Insert a new record in the table.
53 *
54 *
55 * @param rule
56 * The rule object
57 */
58 void insert( Rule rule );
59
60 /**
61 * Load the data of Rule from the table
62 *
63 * @param nRuleId
64 * The identifier of Rule
65 * @param ruleTypesSet
66 * The rule type set
67 * @return the instance of the Rule
68 */
69 Rule load( int nRuleId, IRuleTypesSet ruleTypesSet );
70
71 /**
72 * Load the list of rules
73 *
74 * @param ruleTypesSet
75 * The rule type set
76 * @return The Collection of the Rules
77 */
78 List<Rule> selectRuleList( IRuleTypesSet ruleTypesSet );
79
80 /**
81 * Load the list of rules specified by rule type key
82 *
83 * @param strRuleTypeKey
84 * The rule type key
85 * @param ruleTypesSet
86 * The rule types set
87 * @return The Collection of the Rules
88 */
89 List<Rule> selectRuleListByRuleTypeKey( String strRuleTypeKey, IRuleTypesSet ruleTypesSet );
90
91 /**
92 * Update the record in the table
93 *
94 * @param rule
95 * The reference of rule
96 */
97 void store( Rule rule );
98 }