View Javadoc
1   /*
2    * Copyright (c) 2002-2017, 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.transparency.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.portal.service.plugin.PluginService;
38  import fr.paris.lutece.portal.service.spring.SpringContextService;
39  import fr.paris.lutece.util.ReferenceList;
40  
41  import java.util.List;
42  
43  /**
44   * This class provides instances management methods (create, find, ...) for Lobby objects
45   */
46  public final class LobbyHome
47  {
48      // Static variable pointed at the DAO instance
49      private static ILobbyDAO _dao = SpringContextService.getBean( "transparency.lobbyDAO" );
50      private static Plugin _plugin = PluginService.getPlugin( "transparency" );
51  
52      /**
53       * Private constructor - this class need not be instantiated
54       */
55      private LobbyHome( )
56      {
57      }
58  
59      /**
60       * Create an instance of the lobby class
61       * 
62       * @param lobby
63       *            The instance of the Lobby which contains the informations to store
64       * @return The instance of lobby which has been created with its primary key.
65       */
66      public static Lobby create( Lobby lobby )
67      {
68          _dao.insert( lobby, _plugin );
69  
70          return lobby;
71      }
72  
73      /**
74       * Update of the lobby which is specified in parameter
75       * 
76       * @param lobby
77       *            The instance of the Lobby which contains the data to store
78       * @return The instance of the lobby which has been updated
79       */
80      public static Lobby update( Lobby lobby )
81      {
82          _dao.store( lobby, _plugin );
83  
84          return lobby;
85      }
86  
87      /**
88       * Remove the lobby whose identifier is specified in parameter
89       * 
90       * @param nKey
91       *            The lobby Id
92       */
93      public static void remove( int nKey )
94      {
95          _dao.delete( nKey, _plugin );
96      }
97  
98      /**
99       * Returns an instance of a lobby whose identifier is specified in parameter
100      * 
101      * @param nKey
102      *            The lobby primary key
103      * @return an instance of Lobby
104      */
105     public static Lobby findByPrimaryKey( int nKey )
106     {
107         return _dao.load( nKey, _plugin );
108     }
109 
110     /**
111      * Returns an instance of a lobby whose identifier is specified in parameter
112      * 
113      * @param strNationalId
114      * @return an instance of Lobby
115      */
116     public static Lobby getByNationalId( String strNationalId )
117     {
118         return _dao.loadByNationalId( strNationalId, _plugin );
119     }
120 
121     /**
122      * Load the data of all the lobby objects and returns them as a list
123      * 
124      * @return the list which contains the data of all the lobby objects
125      */
126     public static List<Lobby> getLobbiesList( )
127     {
128         return _dao.selectLobbiesList( null, _plugin );
129     }
130 
131     /**
132      * Load the data of all the lobby objects with Name like %strLikeName% and returns them as a list
133      * 
134      * @return the list which contains the data of all the lobby objects
135      */
136     public static List<Lobby> getLobbiesListNamedLike( String strLikeName )
137     {
138         return _dao.selectLobbiesList( strLikeName, _plugin );
139     }
140 
141     /**
142      * Load the data of all the lobby objects and returns them as a list
143      * 
144      * @param idAppointment
145      * @return the list which contains the data of all the lobby objects
146      */
147     public static List<Lobby> getLobbiesListByAppointment( int idAppointment )
148     {
149         return _dao.selectLobbiesListByAppointment( idAppointment, _plugin );
150     }
151 
152     /**
153      * Load the id of all the lobby objects and returns them as a list
154      * 
155      * @return the list which contains the id of all the lobby objects
156      */
157     public static List<Integer> getIdLobbieslist( )
158     {
159         return _dao.selectIdLobbiesList( _plugin );
160     }
161 
162     /**
163      * Load the data of all the lobby objects and returns them as a referenceList
164      * 
165      * @return the referenceList which contains the data of all the lobby objects
166      */
167     public static ReferenceList getLobbiesReferenceList( )
168     {
169         return _dao.selectLobbiesReferenceList( _plugin );
170     }
171 }