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.wrapper.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.Collection;
39
40
41 /**
42 * wrapperInterface
43 * @author lenaini
44 */
45 public interface IWrapperDAO
46 {
47 /**
48 * Delete a record from the table
49 * @param wrapper The Wrapper object
50 * @param plugin The plugin
51 */
52 void delete( Wrapper wrapper, Plugin plugin );
53
54 /**
55 * Insert a new record in the table.
56 * @param wrapper The wrapper object
57 * @param plugin The plugin
58 */
59 void insert( Wrapper wrapper, Plugin plugin );
60
61 /**
62 * Load the data of Wrapper from the table
63 * @param nWrapperId The identifier of Wrapper
64 * @param plugin The plugin
65 * @return the instance of the Wrapper
66 */
67 Wrapper load( int nWrapperId, Plugin plugin );
68
69 /**
70 * Load the data of enabled Wrapper from the table
71 * @param nWrapperId The identifier of Wrapper
72 * @param plugin The plugin
73 * @return the instance of the Wrapper
74 */
75 Wrapper selectEnabledWrapper( int nWrapperId, Plugin plugin );
76
77 /**
78 * Load the list of wrappers
79 * @param plugin The plugin
80 * @return The Collection of the Wrappers
81 */
82 Collection<Wrapper> selectAll( Plugin plugin );
83
84 /**
85 * Load the list of wrappers with valid status
86 * @param plugin The plugin
87 * @return The Collection of the Wrappers
88 */
89 Collection<Wrapper> selectEnabledWrapperList( Plugin plugin );
90
91 /**
92 * Update the record in the table
93 * @param wrapper The reference of wrapper
94 * @param plugin The plugin
95 */
96 void store( Wrapper wrapper, Plugin plugin );
97 }