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