View Javadoc
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  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  
39  import java.util.List;
40  
41  
42  /**
43   *
44   * DashboardHome
45   *
46   */
47  public final class DashboardHome
48  {
49      // Static variable pointed at the DAO instance
50      private static IDashboardDAO _dao = (IDashboardDAO) SpringContextService.getBean( "dashboardDAO" );
51  
52      /**
53       * Private constructor - this class need not be instantiated
54       */
55      private DashboardHome(  )
56      {
57      }
58  
59      /**
60       * Creation of an instance of DashboardComponent
61       *
62       * @param dashboardComponent The instance of the DashboardComponent which contains the informations to store
63       *
64       */
65      public static void create( IDashboardComponent dashboardComponent )
66      {
67          _dao.insert( dashboardComponent );
68      }
69  
70      /**
71       * Update of the DashboardComponent which is specified in parameter
72       *
73       * @param dashboardComponent The instance of the DashboardComponent which contains the informations to update
74       *
75       */
76      public static void update( IDashboardComponent dashboardComponent )
77      {
78          _dao.store( dashboardComponent );
79      }
80  
81      /**
82       * Remove the DashboardComponent whose identifier is specified in parameter
83       *
84       * @param strBeanName The DashboardComponent id
85       */
86      public static void remove( String strBeanName )
87      {
88          _dao.delete( strBeanName );
89      }
90  
91      /**
92       * Remove the DashboardComponent whose identifier is specified in parameter
93       *
94       */
95      public static void removeAll(  )
96      {
97          _dao.deleteAll(  );
98      }
99  
100     // /////////////////////////////////////////////////////////////////////////
101     // Finders
102 
103     /**
104      * Returns an instance of a DashboardComponent whose identifier is specified in parameter
105      *
106      * @param strBeanName The DashboardComponent primary key
107      * @return an instance of DashboardComponent
108      */
109     public static IDashboardComponent findByPrimaryKey( String strBeanName )
110     {
111         return _dao.load( strBeanName );
112     }
113 
114     /**
115      * Loads the data of all the IDashboardComponent
116      *
117      * @return the list which contains the data of all the IDashboardComponent
118      */
119     public static List<IDashboardComponent> findAll(  )
120     {
121         return _dao.selectAllDashboardComponents(  );
122     }
123 
124     /**
125      * Loads the data of all the IDashboardComponent
126      * @param filter the filter
127      * @return the list which contains the data of all the IDashboardComponent
128      */
129     public static List<IDashboardComponent> findByFilter( DashboardFilter filter )
130     {
131         return _dao.selectDashboardComponents( filter );
132     }
133 
134     /**
135      * Finds the max order for all columns.
136      * @return the max order
137      */
138     public static int findMaxOrder(  )
139     {
140         return _dao.selectMaxOrder(  );
141     }
142 
143     /**
144      * Finds the max order for the column.
145      * @param nColumn the column
146      * @return the max order
147      */
148     public static int findMaxOrder( int nColumn )
149     {
150         return _dao.selectMaxOrder( nColumn );
151     }
152 
153     /**
154      * Finds all columns
155      * @return the list of columns
156      */
157     public static List<Integer> findColumns(  )
158     {
159         return _dao.selectColumns(  );
160     }
161 }