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
35 package fr.paris.lutece.plugins.myportal.modules.myfavorites.business;
36
37 import fr.paris.lutece.portal.service.plugin.Plugin;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.List;
41
42 /**
43 * IMyFavoritesDAO Interface
44 */
45 public interface IMyFavoritesDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param myFavorites
51 * instance of the MyFavorites object to insert
52 * @param plugin
53 * the Plugin
54 */
55 void insert( MyFavorites myFavorites, Plugin plugin );
56
57 /**
58 * Update the record in the table
59 *
60 * @param myFavorites
61 * the reference of the MyFavorites
62 * @param plugin
63 * the Plugin
64 */
65 void store( MyFavorites myFavorites, Plugin plugin );
66
67 /**
68 * Delete a record from the table
69 *
70 * @param nKey
71 * The identifier of the MyFavorites to delete
72 * @param plugin
73 * the Plugin
74 */
75 void delete( int nKey, Plugin plugin );
76
77 // /////////////////////////////////////////////////////////////////////////
78 // Finders
79
80 /**
81 * Load the data from the table
82 *
83 * @param nKey
84 * The identifier of the myFavorites
85 * @param plugin
86 * the Plugin
87 * @return The instance of the myFavorites
88 */
89 MyFavorites load( int nKey, Plugin plugin );
90
91 /**
92 * Load the data of all the myFavorites objects and returns them as a list
93 *
94 * @param plugin
95 * the Plugin
96 * @return The list which contains the data of all the myFavorites objects
97 */
98 List<MyFavorites> selectMyFavoritessList( Plugin plugin );
99
100 /**
101 * Load the id of all the myFavorites objects and returns them as a list
102 *
103 * @param plugin
104 * the Plugin
105 * @return The list which contains the id of all the myFavorites objects
106 */
107 List<Integer> selectIdMyFavoritessList( Plugin plugin );
108
109 /**
110 * Load the data of all the myFavorites objects and returns them as a referenceList
111 *
112 * @param plugin
113 * the Plugin
114 * @return The referenceList which contains the data of all the myFavorites objects
115 */
116 ReferenceList selectMyFavoritessReferenceList( Plugin plugin );
117
118 /**
119 *
120 * @param idUser
121 * @param plugin
122 * @return
123 */
124 List<MyFavorites> selectMyFavoritesList( String idUser, Plugin plugin );
125
126 /**
127 * Return the list of all the order of a user favorites
128 *
129 * @param strIdUser
130 * the id of the user to retrieve the order list from
131 * @param plugin
132 * the Plugin
133 * @return the list of all the order of a user favorites
134 */
135 List<Integer> selectMyFavoritesOrderList( String strIdUser, Plugin plugin );
136
137 /**
138 * Return the favorite of the user with the specified order null otherwise
139 *
140 * @param strIdUser
141 * the id of the user to find the Favorites from
142 * @param nOrder
143 * the order of the favorite to retrieve
144 * @param plugin
145 * the plugin
146 * @return the favorite of the user with the specified order null otherwise
147 */
148 MyFavorites selectUserFavoriteByOrder( String strIdUser, int nOrder, Plugin plugin );
149
150 /**
151 * Update the favorites with the specified id with the new order
152 *
153 * @param nFavoritesId
154 * the id of the favorite to update
155 * @param nOrder
156 * the new order of the favorites
157 * @param plugin
158 * the plugin
159 */
160 void updateFavoritesOrder( int nFavoritesId, int nOrder, Plugin plugin );
161 }