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.mydashboard.modules.favorites.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 Favorite objects
45 */
46 public final class FavoriteHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IFavoriteDAO _dao = SpringContextService.getBean( "favorites.favoriteDAO" );
50 private static Plugin _plugin = PluginService.getPlugin( "favorites" );
51
52 /**
53 * Private constructor - this class need not be instantiated
54 */
55 private FavoriteHome( )
56 {
57 }
58
59 /**
60 * Create an instance of the favorite class
61 * @param favorite The instance of the Favorite which contains the informations to store
62 * @return The instance of favorite which has been created with its primary key.
63 */
64 public static Favorite../../../../../../../../fr/paris/lutece/plugins/mydashboard/modules/favorites/business/Favorite.html#Favorite">Favorite create( Favorite favorite )
65 {
66 _dao.insert( favorite, _plugin );
67
68 return favorite;
69 }
70
71 /**
72 * Update of the favorite which is specified in parameter
73 * @param favorite The instance of the Favorite which contains the data to store
74 * @return The instance of the favorite which has been updated
75 */
76 public static Favorite../../../../../../../../fr/paris/lutece/plugins/mydashboard/modules/favorites/business/Favorite.html#Favorite">Favorite update( Favorite favorite )
77 {
78 _dao.store( favorite, _plugin );
79
80 return favorite;
81 }
82
83 /**
84 * Remove the favorite whose identifier is specified in parameter
85 * @param nKey The favorite Id
86 */
87 public static void remove( int nKey )
88 {
89 _dao.delete( nKey, _plugin );
90 }
91
92 /**
93 * Returns an instance of a favorite whose identifier is specified in parameter
94 * @param nKey The favorite primary key
95 * @return an instance of Favorite
96 */
97 public static Favorite findByPrimaryKey( int nKey )
98 {
99 return _dao.load( nKey, _plugin);
100 }
101
102 /**
103 * Load the data of all the favorite objects and returns them as a list
104 * @return the list which contains the data of all the favorite objects
105 */
106 public static List<Favorite> getFavoritesList( )
107 {
108 return _dao.selectFavoritesList( _plugin );
109 }
110
111 /**
112 * Load the data of all the activated favorite objects and returns them as a list
113 * @return the list which contains the data of all the favorite objects
114 */
115 public static List<Favorite> getActivatedFavoritesList( )
116 {
117 return _dao.selectActivatedFavoritesList( _plugin );
118 }
119
120 /**
121 * Load the id of all the favorite objects and returns them as a list
122 * @return the list which contains the id of all the favorite objects
123 */
124 public static List<Integer> getIdFavoritesList( )
125 {
126 return _dao.selectIdFavoritesList( _plugin );
127 }
128
129 /**
130 * Load the data of all the favorite objects and returns them as a referenceList
131 * @return the referenceList which contains the data of all the favorite objects
132 */
133 public static ReferenceList getFavoritesReferenceList( )
134 {
135 return _dao.selectFavoritesReferenceList(_plugin );
136 }
137
138 /**
139 * Return the number of favorite for one id remote and one provider name
140 * @param strProviderName the favorite provider name
141 * @param strRemoteId the favorite remote id
142 * @param plugin the Plugin
143 * @return the number of favorite for one id remote and one provider name
144 */
145 public static int getNumberFavoriteProviderRemoteId( String strProviderName, String strRemoteId )
146 {
147 return _dao.countProviderNameRemoteId( strProviderName, strRemoteId, _plugin );
148 }
149
150 /**
151 * Get the default favorites list
152 * @return the default favorites list
153 */
154 public static List<Favorite> getFavoritesListDefault( )
155 {
156 return _dao.selectDefaultFavoritesList( _plugin );
157 }
158
159 /**
160 * Return the number of favorite for one id remote and one provider name
161 * @param strCategoryCode the category code
162 * @return the List which contains the data of all the favorites filtered by the category code
163 */
164 public static List<Favorite> getFavoritesListByCategoryCode( String strCategoryCode )
165 {
166 return _dao.selectCategoryCodeFavoritesList( strCategoryCode, _plugin );
167 }
168
169 public static List<Favorite> getActivatedFavoritesListByCode( String strCategoryCode )
170 {
171 return _dao.selectCategoryCodeActivatedFavoritesList( strCategoryCode, _plugin );
172 }
173 }
174