1 /*
2 * Copyright (c) 2002-2017, 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.directory.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 *
42 * Interface IRecordDAO
43 *
44 */
45 public interface IRecordDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param record
51 * instance of the Record object to insert
52 * @param plugin
53 * the plugin
54 * @return the key of the new record
55 */
56 int insert( Record record, Plugin plugin );
57
58 /**
59 * Load the data of the record from the table
60 *
61 * @param nIdRecord
62 * The identifier of the id record
63 * @param plugin
64 * the plugin
65 * @return the instance of the Record
66 */
67 Record load( int nIdRecord, Plugin plugin );
68
69 /**
70 * Test if the given directory record list as a worflow
71 *
72 * @param nIdDirectory
73 * directory Id
74 * @param plugin
75 * the plugin
76 * @return true if has at least one
77 */
78 Boolean direcytoryRecordListHasWorkflow( int nIdDirectory, Plugin plugin );
79
80 /**
81 * Load a list of record
82 *
83 * @param listId
84 * list of record id
85 * @param plugin
86 * the plugin
87 * @return list of Record
88 */
89 List<Record> loadList( List<Integer> listId, Plugin plugin );
90
91 /**
92 * Delete a record from the table
93 *
94 * @param nIdRecord
95 * The identifier of the record
96 * @param plugin
97 * the plugin
98 */
99 void delete( int nIdRecord, Plugin plugin );
100
101 /**
102 * Delete list of record by directory id
103 *
104 * @param nDirectoryId
105 * the directory id
106 * @param plugin
107 * the plugin
108 */
109 void deleteRecordByDirectoryId( Integer nDirectoryId, Plugin plugin );
110
111 /**
112 * Update the the record in the table
113 *
114 * @param record
115 * the record to update
116 * @param plugin
117 * the plugin
118 */
119 void store( Record record, Plugin plugin );
120
121 /**
122 * Load the data of all the record who verify the filter and returns them in a list
123 *
124 * @param filter
125 * the filter
126 * @param plugin
127 * the plugin
128 * @return the list of record
129 */
130 List<Record> selectListByFilter( RecordFieldFilter filter, Plugin plugin );
131
132 /**
133 * Count record who verify the filter
134 *
135 * @param filter
136 * the filter
137 * @param plugin
138 * the plugin
139 * @return the number of record
140 */
141 int selectCountByFilter( RecordFieldFilter filter, Plugin plugin );
142
143 /**
144 * Load the data of all the record id who verify the filter and returns them in a list
145 *
146 * @param filter
147 * the filter
148 * @param plugin
149 * the plugin
150 * @return the list of record id
151 */
152 List<Integer> selectListIdByFilter( RecordFieldFilter filter, Plugin plugin );
153
154 /**
155 * Get directory id by record id
156 *
157 * @param nRecordId
158 * the record id
159 * @param plugin
160 * the plugin
161 * @return directory id
162 */
163 Integer getDirectoryIdByRecordId( Integer nRecordId, Plugin plugin );
164 }