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