1 /*
2 * Copyright (c) 2002-2021, City of 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.grafana.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38 import java.util.List;
39
40 /**
41 * IDashboardDAO Interface
42 */
43 public interface IDashboardDAO
44 {
45 /**
46 * Insert a new record in the table.
47 *
48 * @param dashboard
49 * instance of the Dashboard object to insert
50 * @param plugin
51 * the Plugin
52 */
53 void insert( Dashboard dashboard, Plugin plugin );
54
55 /**
56 * Load the data from the table
57 *
58 * @param nKey
59 * The identifier of the dashboard
60 * @param plugin
61 * the Plugin
62 * @return The instance of the dashboard
63 */
64 Dashboard load( int nKey, Plugin plugin );
65
66 /**
67 * Load the data from the table
68 *
69 * @param strIdGrafana
70 * The identifier of the dashboard in Grafana
71 * @param plugin
72 * the Plugin
73 * @return The instance of the dashboard
74 */
75 Dashboard loadByGrafanaId( String strIdGrafana, Plugin plugin );
76
77 /**
78 * Load the data of all the dashboard objects and returns them as a list
79 *
80 * @param plugin
81 * the Plugin
82 * @return The list which contains the data of all the dashboard objects
83 */
84 List<Dashboard> selectDashboardsList( Plugin plugin );
85
86 /**
87 * Load the id of all the dashboard objects and returns them as a list
88 *
89 * @param plugin
90 * the Plugin
91 * @return The list which contains the id of all the dashboard objects
92 */
93 List<Integer> selectIdDashboardsList( Plugin plugin );
94
95 /**
96 * Load the data of all the dashboard objects and returns them as a referenceList
97 *
98 * @param plugin
99 * the Plugin
100 * @return The referenceList which contains the data of all the dashboard objects
101 */
102 ReferenceList selectDashboardsReferenceList( Plugin plugin );
103
104 /**
105 * Update the record in the table
106 *
107 * @param dashboard
108 * the reference of the Dashboard
109 * @param plugin
110 * the Plugin
111 */
112 void store( Dashboard dashboard, Plugin plugin );
113
114 /**
115 * Delete the given dashboard
116 *
117 * @param nIdDashboard
118 * the dashboard id to delete
119 * @param plugin
120 * the Plugin
121 */
122 void delete( int nIdDashboard, Plugin plugin );
123
124 /**
125 * Delete all the dashboards in the table
126 *
127 * @param plugin
128 */
129 void deleteAll( Plugin plugin );
130
131 /**
132 * check if given dashboard exists, based on Grafana dashboard id
133 *
134 * @param dashboard
135 * @param plugin
136 * @return true if exists, false otherwise
137 */
138 boolean isDashboardExists( Dashboard dashboard, Plugin plugin );
139
140 }