1 /*
2 * Copyright (c) 2002-2016, 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.mydashboard.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.List;
40
41
42 /**
43 * IDashboardAssociationDAO Interface
44 */
45 public interface IDashboardAssociationDAO
46 {
47 /**
48 * Insert a new record in the table.
49 * @param dashboardAssociation instance of the DashboardAssociation object to insert
50 * @param plugin the Plugin
51 */
52 void insert( DashboardAssociation dashboardAssociation, Plugin plugin );
53
54 /**
55 * Update the record in the table
56 * @param dashboardAssociation the reference of the DashboardAssociation
57 * @param plugin the Plugin
58 */
59 void store( DashboardAssociation dashboardAssociation, Plugin plugin );
60
61 /**
62 * Delete a record from the table
63 * @param nKey The identifier of the DashboardAssociation to delete
64 * @param plugin the Plugin
65 */
66 void delete( int nKey, Plugin plugin );
67
68 ///////////////////////////////////////////////////////////////////////////
69 // Finders
70
71 /**
72 * Load the data from the table
73 * @param nKey The identifier of the dashboardAssociation
74 * @param plugin the Plugin
75 * @return The instance of the dashboardAssociation
76 */
77 DashboardAssociation load( int nKey, Plugin plugin );
78
79 /**
80 * Load the data of all the dashboardAssociation objects and returns them as a list
81 * @param plugin the Plugin
82 * @return The list which contains the data of all the dashboardAssociation objects
83 */
84 List<DashboardAssociation> selectDashboardAssociationsList( Plugin plugin );
85
86 /**
87 * Load the data of all the dashboardAssociation objects associated to a panel and returns them as a list
88 * @param nIdPanel the panel Id
89 * @param plugin the Plugin
90 * @return The list which contains the data of all the dashboardAssociation objects
91 */
92 List<DashboardAssociation> selectDashboardAssociationsListByIdPanel( int nIdPanel, Plugin plugin );
93
94 /**
95 * return the number of association
96 * @param plugin the plugin
97 * @return the number of association
98 */
99 int selectCountDashboardAssociations( Plugin plugin );
100
101 /**
102 * Load the id of all the dashboardAssociation objects and returns them as a list
103 * @param plugin the Plugin
104 * @return The list which contains the id of all the dashboardAssociation objects
105 */
106 List<Integer> selectIdDashboardAssociationsList( Plugin plugin );
107
108 /**
109 * Load the data of all the dashboardAssociation objects and returns them as a referenceList
110 * @param plugin the Plugin
111 * @return The referenceList which contains the data of all the dashboardAssociation objects
112 */
113 ReferenceList selectDashboardAssociationsReferenceList( Plugin plugin );
114 }