1 /*
2 * Copyright (c) 2002-2014, 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.myportal.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 *
42 * IStyleDAO Interface
43 *
44 */
45 public interface IWidgetStyleDAO
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 style
60 * instance of the Style object to inssert
61 * @param plugin
62 * the Plugin
63 */
64 void insert( Style style, Plugin plugin );
65
66 /**
67 * Update the record in the table
68 *
69 * @param style
70 * the reference of the Style
71 * @param plugin
72 * the Plugin
73 */
74 void store( Style style, Plugin plugin );
75
76 /**
77 * Delete a record from the table
78 *
79 * @param nIdStyle
80 * int identifier of the Style to delete
81 * @param plugin
82 * the Plugin
83 */
84 void delete( int nIdStyle, Plugin plugin );
85
86 // /////////////////////////////////////////////////////////////////////////
87 // Finders
88
89 /**
90 * Load the data from the table
91 *
92 * @param nKey
93 * The identifier of the style
94 * @param plugin
95 * the Plugin
96 * @return The instance of the style
97 */
98 Style load( int nKey, Plugin plugin );
99
100 /**
101 * Load the data of all the style objects and returns them as a List
102 *
103 * @param plugin
104 * the Plugin
105 * @return The List which contains the data of all the style objects
106 */
107 List<Style> selectStylesList( Plugin plugin );
108 }