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 java.util.List;
38
39 /**
40 *
41 * IFileDAO
42 *
43 */
44 public interface IFileDAO
45 {
46 /**
47 * Generates a new primary key
48 *
49 * @param plugin
50 * the plugin
51 * @return The new primary key
52 */
53 int newPrimaryKey( Plugin plugin );
54
55 /**
56 * Insert a new record in the table.
57 *
58 * @param file
59 * instance of the File object to insert
60 * @param plugin
61 * the plugin
62 * @return the id of the new file
63 */
64 int insert( File file, Plugin plugin );
65
66 /**
67 * Load the data of the File from the table
68 *
69 * @param nId
70 * The identifier of the file
71 * @param plugin
72 * the plugin
73 * @return the instance of the File
74 */
75 File load( int nId, Plugin plugin );
76
77 /**
78 * Delete a record from the table
79 *
80 * @param nIdFile
81 * The identifier of the file
82 * @param plugin
83 * the plugin
84 */
85 void delete( int nIdFile, Plugin plugin );
86
87 /**
88 * Update the file in the table
89 *
90 * @param file
91 * instance of the File object to update
92 * @param plugin
93 * the plugin
94 */
95 void store( File file, Plugin plugin );
96
97 /**
98 * Purge file in the table
99 *
100 * @param file
101 * instance of the File object to purge
102 * @param plugin
103 * the plugin
104 */
105 void purge( File file, Plugin plugin );
106
107 /**
108 * Get the files list
109 *
110 * @param plugin
111 * the plugin
112 * @return the list of files
113 */
114 List<File> selectFilesList( Plugin plugin );
115
116 }