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 * IDirectoryXslDAO
43 *
44 */
45 public interface IDirectoryXslDAO
46 {
47 /**
48 * Generates a new primary key
49 *
50 * @param plugin
51 * the plugin
52 * @return The new primary key
53 */
54 int newPrimaryKey( Plugin plugin );
55
56 /**
57 * Insert a new record in the table.
58 *
59 * @param directoryXsl
60 * instance of the DirectoryXsl object to insert
61 * @param plugin
62 * the plugin
63 */
64 void insert( DirectoryXsl directoryXsl, Plugin plugin );
65
66 /**
67 * Load the data of the DirectoryXsl from the table
68 *
69 * @param nId
70 * The identifier of the xsl
71 * @param plugin
72 * the plugin
73 * @return the instance of the DirectoryXsl
74 */
75 DirectoryXsl load( int nId, Plugin plugin );
76
77 /**
78 * Load the data of the DirectoryXsl from the table
79 *
80 * @param nIdFile
81 * The identifier of the file
82 * @param plugin
83 * the plugin
84 * @return the instance of the DirectoryXsl
85 */
86 DirectoryXsl loadByFile( int nIdFile, Plugin plugin );
87
88 /**
89 * Delete a record from the table
90 *
91 * @param nIdDirectoryXsl
92 * The identifier of the directory xsl
93 * @param plugin
94 * the plugin
95 */
96 void delete( int nIdDirectoryXsl, Plugin plugin );
97
98 /**
99 * Update the directoryXsl in the table
100 *
101 * @param directoryXsl
102 * instance of the DirectoryXsl object to update
103 * @param plugin
104 * the plugin
105 */
106 void store( DirectoryXsl directoryXsl, Plugin plugin );
107
108 /**
109 * Load the data of all the xsl and returns them in form of a list
110 *
111 * @param filter
112 * the search filter
113 * @param plugin
114 * the plugin
115 * @return The List which contains the data of all the XSL
116 */
117 List<DirectoryXsl> selectList( DirectoryXslFilter filter, Plugin plugin );
118 }