1 /*
2 * Copyright (c) 2002-2024, 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.identityimport.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 import java.util.Optional;
43
44 /**
45 * This class provides instances management methods (create, find, ...) for Client objects
46 */
47 public final class ClientHome
48 {
49 // Static variable pointed at the DAO instance
50 private static IClientDAO _dao = SpringContextService.getBean( "identityimport.clientDAO" );
51 private static Plugin _plugin = PluginService.getPlugin( "identityimport" );
52
53 /**
54 * Private constructor - this class need not be instantiated
55 */
56 private ClientHome( )
57 {
58 }
59
60 /**
61 * Create an instance of the client class
62 *
63 * @param client
64 * The instance of the Client which contains the information to store
65 * @return The instance of client which has been created with its primary key.
66 */
67 public static Client="../../../../../../fr/paris/lutece/plugins/identityimport/business/Client.html#Client">Client create( Client client )
68 {
69 _dao.insert( client, _plugin );
70
71 return client;
72 }
73
74 /**
75 * Update of the client which is specified in parameter
76 *
77 * @param client
78 * The instance of the Client which contains the data to store
79 * @return The instance of the client which has been updated
80 */
81 public static Client="../../../../../../fr/paris/lutece/plugins/identityimport/business/Client.html#Client">Client update( Client client )
82 {
83 _dao.store( client, _plugin );
84
85 return client;
86 }
87
88 /**
89 * Remove the client whose identifier is specified in parameter
90 *
91 * @param nKey
92 * The client Id
93 */
94 public static void remove( int nKey )
95 {
96 _dao.delete( nKey, _plugin );
97 }
98
99 /**
100 * Returns an instance of a client whose identifier is specified in parameter
101 *
102 * @param nKey
103 * The client primary key
104 * @return an instance of Client
105 */
106 public static Optional<Client> findByPrimaryKey( int nKey )
107 {
108 return _dao.load( nKey, _plugin );
109 }
110
111 /**
112 * Returns an instance of a client whose client code is specified in parameter
113 *
114 * @param clientCode
115 * The client code
116 * @return an instance of Client
117 */
118 public static Optional<Client> findByClientCode( final String clientCode )
119 {
120 return _dao.selectClientByClientCode( _plugin, clientCode );
121 }
122
123 /**
124 * Load the data of all the client objects and returns them as a list
125 *
126 * @return the list which contains the data of all the client objects
127 */
128 public static List<Client> getClientsList( )
129 {
130 return _dao.selectClientsList( _plugin );
131 }
132
133 /**
134 * Load the id of all the client objects and returns them as a list
135 *
136 * @return the list which contains the id of all the client objects
137 */
138 public static List<Integer> getIdClientsList( )
139 {
140 return _dao.selectIdClientsList( _plugin );
141 }
142
143 /**
144 * Load the data of all the client objects and returns them as a referenceList
145 *
146 * @return the referenceList which contains the data of all the client objects
147 */
148 public static ReferenceList getClientsReferenceList( )
149 {
150 return _dao.selectClientsReferenceList( _plugin );
151 }
152
153 /**
154 * Load the data of all the avant objects and returns them as a list
155 *
156 * @param listIds
157 * liste of ids
158 * @return the list which contains the data of all the avant objects
159 */
160 public static List<Client> getClientsListByIds( List<Integer> listIds )
161 {
162 return _dao.selectClientsListByIds( _plugin, listIds );
163 }
164
165 /**
166 * Load the data of all the client objects and returns them as a list
167 *
168 * @param appCode
169 * the app code
170 * @return The list which contains the data of all the client objects
171 */
172 public static List<Client> getClientsListByAppCode( final String appCode ) {
173 return _dao.selectClientsListByAppCode(_plugin, appCode);
174 }
175
176 }