1 /*
2 * Copyright (c) 2002-2014, Mairie de 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.digglike.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40
41 /**
42 * IEntryDAO Interface
43 */
44 public interface IEntryDAO
45 {
46 /**
47 * Insert a new record in the table.
48 *
49 * @param entry instance of the Entry object to insert
50 * @param plugin the plugin
51 * @return the id of the new entry
52 */
53 int insert( IEntry entry, Plugin plugin );
54
55 /**
56 * Update the entry in the table
57 *
58 * @param entry instance of the Entry object to update
59 * @param plugin the plugin
60 */
61 void store( IEntry entry, Plugin plugin );
62
63 /**
64 * Delete a record from the table
65 *
66 * @param nIdEntry The identifier of the entry
67 * @param plugin the plugin
68 */
69 void delete( int nIdEntry, Plugin plugin );
70
71 ///////////////////////////////////////////////////////////////////////////
72 // Finders
73
74 /**
75 * Load the data of the entry from the table
76 *
77 * @param nIdEntry The identifier of the entry
78 * @param plugin the plugin
79 * @return the instance of the Entry
80 */
81 IEntry load( int nIdEntry, Plugin plugin );
82
83 /**
84 * Load the data of all the entry who verify the filter and returns them in
85 * a list
86 *
87 * @param filter the filter
88 * @param plugin the plugin
89 * @return the list of entry
90 */
91 List<IEntry> selectEntryListByFilter( EntryFilter filter, Plugin plugin );
92
93 /**
94 * Return the number of entry who verify the filter
95 *
96 * @param filter the filter
97 * @param plugin the plugin
98 * @return the number of entry who verify the filter
99 */
100 int selectNumberEntryByFilter( EntryFilter filter, Plugin plugin );
101
102 /**
103 * Delete an association between entry and a regular expression
104 *
105 * @param nIdEntry The identifier of the field
106 * @param nIdExpression The identifier of the regular expression
107 * @param plugin the plugin
108 */
109 void deleteVerifyBy( int nIdEntry, int nIdExpression, Plugin plugin );
110
111 /**
112 * insert an association between entry and a regular expression
113 *
114 * @param nIdEntry The identifier of the entry
115 * @param nIdExpression The identifier of the regular expression
116 * @param plugin the plugin
117 */
118 void insertVerifyBy( int nIdEntry, int nIdExpression, Plugin plugin );
119
120 /**
121 * Load the key of all the regularExpression associate to the entry and
122 * returns them in a list
123 * @param nIdEntry the id of entry
124 * @param plugin the plugin
125 * @return the list of regular expression key
126 */
127 List<Integer> selectListRegularExpressionKeyByIdEntry( int nIdEntry, Plugin plugin );
128
129 /**
130 * verify if the regular expresssion is use
131 *
132 * @param nIdExpression The identifier of the entry
133 * @param plugin the plugin
134 * @return true if the regular expression is use
135 */
136 boolean isRegularExpressionIsUse( int nIdExpression, Plugin plugin );
137 }