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 import fr.paris.lutece.util.ReferenceList;
38
39 /*
40 * Copyright (c) 2002-2014, Mairie de Paris
41 * All rights reserved.
42 *
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 *
47 * 1. Redistributions of source code must retain the above copyright notice
48 * and the following disclaimer.
49 *
50 * 2. Redistributions in binary form must reproduce the above copyright notice
51 * and the following disclaimer in the documentation and/or other materials
52 * provided with the distribution.
53 *
54 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
55 * contributors may be used to endorse or promote products derived from
56 * this software without specific prior written permission.
57 *
58 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
59 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
62 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
63 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
64 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
65 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
66 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
67 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
68 * POSSIBILITY OF SUCH DAMAGE.
69 *
70 * License 1.0
71 */
72 import java.util.List;
73
74 /**
75 * IDirectoryDAO Interface
76 */
77 public interface IDirectoryDAO
78 {
79 /**
80 * Insert a new record in the table.
81 *
82 * @param directory
83 * instance of the Directory to insert
84 * @param plugin
85 * the plugin
86 * @return the id of the new directory
87 */
88 int insert( Directory directory, Plugin plugin );
89
90 /**
91 * Update the directory in the table
92 *
93 * @param directory
94 * instance of the Directory object to update
95 * @param plugin
96 * the plugin
97 */
98 void store( Directory directory, Plugin plugin );
99
100 /**
101 * Delete a record directory the table
102 *
103 * @param nIdDirectory
104 * The identifier of the directory
105 * @param plugin
106 * the plugin
107 */
108 void delete( int nIdDirectory, Plugin plugin );
109
110 /**
111 * Load the data of the Directory from the table
112 *
113 * @param nKey
114 * The identifier of the directory
115 * @param plugin
116 * the plugin
117 * @return the instance of the Directory
118 */
119 Directory load( int nKey, Plugin plugin );
120
121 /**
122 * Load the data of all the directory 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 directory
129 */
130 List<Directory> selectDirectoryList( DirectoryFilter filter, Plugin plugin );
131
132 /**
133 * Load the data of all enable directory returns them in a reference list
134 *
135 * @param plugin
136 * the plugin
137 * @return a reference list of directory
138 */
139 ReferenceList getEnableDirectoryList( Plugin plugin );
140 }