1 /*
2 * Copyright (c) 2002-2022, 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.portal.business.dashboard;
35
36 import fr.paris.lutece.portal.service.dashboard.admin.IAdminDashboardComponent;
37
38 import java.util.List;
39
40 /**
41 *
42 * IAdminDashboardDAO
43 *
44 */
45 public interface IAdminDashboardDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param dashboardComponent
51 * instance of the dashboardComponent object to insert
52 */
53 void insert( IAdminDashboardComponent dashboardComponent );
54
55 /**
56 * Load the data of the IndexerAction from the table
57 *
58 * @param strBeanName
59 * The identifier of the action
60 * @return the instance of the IndexerAction
61 */
62 IAdminDashboardComponent load( String strBeanName );
63
64 /**
65 * Delete a record from the table
66 *
67 * @param strBeanName
68 * The identifier of the dashboard
69 */
70 void delete( String strBeanName );
71
72 /**
73 * Delete all record from the table
74 *
75 */
76 void deleteAll( );
77
78 /**
79 * Update the dashboardComponent in the table
80 *
81 * @param dashboardComponent
82 * instance of the IAdminDashboardComponent object to update
83 */
84 void store( IAdminDashboardComponent dashboardComponent );
85
86 /**
87 * Finds all AdminDashboardComponent
88 *
89 * @return all AdminDashboardComponent
90 */
91 List<IAdminDashboardComponent> selectAllDashboardComponents( );
92
93 /**
94 * Finds all dashboard components matching filter
95 *
96 * @param filter
97 * the filter
98 * @return all dashboard components matching filter
99 */
100 List<IAdminDashboardComponent> selectDashboardComponents( AdminDashboardFilter filter );
101
102 /**
103 * Returns the max order value, for all columns
104 *
105 * @return the max order
106 */
107 int selectMaxOrder( );
108
109 /**
110 * Returns the max order value, for the given column
111 *
112 * @param nColumn
113 * the column
114 * @return the max order
115 */
116 int selectMaxOrder( int nColumn );
117
118 /**
119 * Returns the columns list
120 *
121 * @return the columns list
122 */
123 List<Integer> selectColumns( );
124 }