1 /*
2 * Copyright (c) 2002-2016, 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.myportal.modules.myfavorites.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 MyFavorites objects
45 */
46 public final class MyFavoritesHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IMyFavoritesDAO _dao = SpringContextService.getBean( "myportal-myfavorites.myFavoritesDAO" );
50 private static Plugin _plugin = PluginService.getPlugin( "myportal-myfavorites" );
51
52 /**
53 * Private constructor - this class need not be instantiated
54 */
55 private MyFavoritesHome( )
56 {
57 }
58
59 /**
60 * Create an instance of the myFavorites class
61 *
62 * @param myFavorites
63 * The instance of the MyFavorites which contains the informations to store
64 * @return The instance of myFavorites which has been created with its primary key.
65 */
66 public static MyFavorites create( MyFavorites myFavorites )
67 {
68 _dao.insert( myFavorites, _plugin );
69
70 return myFavorites;
71 }
72
73 /**
74 * Update of the myFavorites which is specified in parameter
75 *
76 * @param myFavorites
77 * The instance of the MyFavorites which contains the data to store
78 * @return The instance of the myFavorites which has been updated
79 */
80 public static MyFavorites update( MyFavorites myFavorites )
81 {
82 _dao.store( myFavorites, _plugin );
83
84 return myFavorites;
85 }
86
87 /**
88 * Remove the myFavorites whose identifier is specified in parameter
89 *
90 * @param nKey
91 * The myFavorites Id
92 */
93 public static void remove( int nKey )
94 {
95 _dao.delete( nKey, _plugin );
96 }
97
98 /**
99 * Returns an instance of a myFavorites whose identifier is specified in parameter
100 *
101 * @param nKey
102 * The myFavorites primary key
103 * @return an instance of MyFavorites
104 */
105 public static MyFavorites findByPrimaryKey( int nKey )
106 {
107 return _dao.load( nKey, _plugin );
108 }
109
110 /**
111 * Load the data of all the myFavorites objects and returns them as a list
112 *
113 * @return the list which contains the data of all the myFavorites objects
114 */
115 public static List<MyFavorites> getMyFavoritessList( )
116 {
117 return _dao.selectMyFavoritessList( _plugin );
118 }
119
120 /**
121 * Load the data of all the myFavorites objects and returns them as a list
122 *
123 * @return the list which contains the data of all the myFavorites objects
124 */
125 public static List<MyFavorites> getMyFavoritessList( String idUser )
126 {
127 return _dao.selectMyFavoritesList( idUser, _plugin );
128 }
129
130 /**
131 * Load the id of all the myFavorites objects and returns them as a list
132 *
133 * @return the list which contains the id of all the myFavorites objects
134 */
135 public static List<Integer> getIdMyFavoritessList( )
136 {
137 return _dao.selectIdMyFavoritessList( _plugin );
138 }
139
140 /**
141 * Load the data of all the myFavorites objects and returns them as a referenceList
142 *
143 * @return the referenceList which contains the data of all the myFavorites objects
144 */
145 public static ReferenceList getMyFavoritessReferenceList( )
146 {
147 return _dao.selectMyFavoritessReferenceList( _plugin );
148 }
149
150 /**
151 * Load the list of the order of the favorites of a user
152 *
153 * @param strIdUser
154 * the id of the user
155 * @return the list of all order of the favorites of the user
156 */
157 public static List<Integer> getUserFavoritesOrder( String strIdUser )
158 {
159 return _dao.selectMyFavoritesOrderList( strIdUser, _plugin );
160 }
161
162 /**
163 * Return the favorite of the user with the specified order null otherwise
164 *
165 * @param strIdUser
166 * the id of the user
167 * @param nOrder
168 * the order of the Favorite
169 * @return the favorite of the user with the specified order null otherwise
170 */
171 public static MyFavorites getUserFavoriteWithOrder( String strIdUser, int nOrder )
172 {
173 return _dao.selectUserFavoriteByOrder( strIdUser, nOrder, _plugin );
174 }
175
176 /**
177 * Update the favorites with the specified id with the new order
178 *
179 * @param nIdFavorites
180 * the id of the favorites
181 * @param nNewOrder
182 * the new ordr of the favorites
183 */
184 public static void updateFavoriteOrder( int nIdFavorites, int nNewOrder )
185 {
186 _dao.updateFavoritesOrder( nIdFavorites, nNewOrder, _plugin );
187 }
188 }