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 * IEntryDAO Interface
42 */
43 public interface IEntryDAO
44 {
45 /**
46 * Insert a new record in the table.
47 *
48 * @param entry
49 * instance of the Entry object to insert
50 * @param plugin
51 * the plugin
52 * @return the id of the new entry
53 */
54 int insert( IEntry entry, Plugin plugin );
55
56 /**
57 * Update the entry in the table
58 *
59 * @param entry
60 * instance of the Entry object to update
61 * @param plugin
62 * the plugin
63 */
64 void store( IEntry entry, Plugin plugin );
65
66 /**
67 * Delete a record from the table
68 *
69 * @param nIdEntry
70 * The identifier of the entry
71 * @param plugin
72 * the plugin
73 */
74 void delete( int nIdEntry, Plugin plugin );
75
76 // /////////////////////////////////////////////////////////////////////////
77 // Finders
78
79 /**
80 * Load the data of the entry from the table
81 *
82 * @param nIdEntry
83 * The identifier of the entry
84 * @param plugin
85 * the plugin
86 * @return the instance of the Entry
87 */
88 IEntry load( int nIdEntry, Plugin plugin );
89
90 /**
91 * Load the data of all the entry who verify the filter and returns them in a list
92 *
93 * @param filter
94 * the filter
95 * @param plugin
96 * the plugin
97 * @return the list of entry
98 */
99 List<IEntry> selectEntryListByFilter( EntryFilter filter, Plugin plugin );
100
101 /**
102 * Load the data of all the entry who verify the filter and returns them in a list
103 *
104 * @param idTypeEntryList
105 * a of entry type needed (by id)
106 * @param filter
107 * the filter
108 * @param plugin
109 * the plugin
110 * @return the list of entry
111 */
112 List<IEntry> selectEntryListByTypeByFilter( List<Integer> idTypeEntryList, EntryFilter filter, Plugin plugin );
113
114 /**
115 * Return the number of entry who verify the filter
116 *
117 * @param filter
118 * the filter
119 * @param plugin
120 * the plugin
121 * @return the number of entry who verify the filter
122 */
123 int selectNumberEntryByFilter( EntryFilter filter, Plugin plugin );
124
125 /**
126 * Get the list of entries whith their titles, their ids and their anonymization status. Also get the class name of the entry type.
127 *
128 * @param plugin
129 * The plugin
130 * @return A list of entries with their titles, their ids and their anonymization status.
131 */
132 List<IEntry> getEntryListAnonymizeStatus( Plugin plugin );
133
134 /**
135 * Update an entry anonymization status
136 *
137 * @param nEntryId
138 * Id of the entry
139 * @param bAnonymize
140 * True if the entry should be anonymize, false otherwise
141 * @param plugin
142 * The plugin
143 */
144 void updateEntryAnonymizeStatus( Integer nEntryId, Boolean bAnonymize, Plugin plugin );
145
146 /**
147 * Finds all the entries without any parent
148 *
149 * @param plugin
150 * the plugin
151 * @param nIdDirectory
152 * the id of the concerned directory
153 * @return List of IEntry the list of all the entries without parent
154 */
155 List<IEntry> findEntriesWithoutParent( Plugin plugin, int nIdDirectory );
156 }