1 /*
2 * Copyright (c) 2002-2021, 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.extend.modules.favorite.service;
35
36 import fr.paris.lutece.plugins.extend.modules.favorite.business.Favorite;
37 import fr.paris.lutece.plugins.extend.modules.favorite.business.FavoriteFilter;
38 import fr.paris.lutece.portal.service.security.LuteceUser;
39
40 import org.springframework.transaction.annotation.Transactional;
41
42 import java.util.List;
43
44 import javax.servlet.http.HttpServletRequest;
45
46 /**
47 * IFavoriteService.
48 */
49 public interface IFavoriteService
50 {
51 /**
52 * Delete.
53 *
54 * @param nIdFavorite
55 * the nId favorite
56 */
57 @Transactional( FavoritePlugin.TRANSACTION_MANAGER )
58 void remove( int nIdFavorite );
59
60 /**
61 * Delete by resource
62 *
63 * @param strIdExtendableResource
64 * the str id extendable resource
65 * @param strExtendableResourceType
66 * the str extendable resource type
67 */
68 @Transactional( FavoritePlugin.TRANSACTION_MANAGER )
69 void removeByResource( String strIdExtendableResource, String strExtendableResourceType );
70
71 /**
72 * Insert.
73 *
74 * @param favorite
75 * the favorite
76 */
77 @Transactional( FavoritePlugin.TRANSACTION_MANAGER )
78 void create( Favorite favorite );
79
80 /**
81 * Store.
82 *
83 * @param favorite
84 * the favorite
85 */
86 @Transactional( FavoritePlugin.TRANSACTION_MANAGER )
87 void update( Favorite favorite );
88
89 /**
90 * Increment vote.
91 *
92 * @param strIdExtendableResource
93 * the str id extendable resource
94 * @param strExtendableResourceType
95 * the str extendable resource type
96 * @param nVoteValue
97 * the n vote value
98 * @param request
99 * the request
100 */
101 @Transactional( FavoritePlugin.TRANSACTION_MANAGER )
102 void doFavorite( String strIdExtendableResource, String strExtendableResourceType, int nVoteValue, HttpServletRequest request );
103
104 /**
105 * Do cancel the vote of a user
106 *
107 * @param user
108 * The user
109 * @param strIdExtendableResource
110 * The id of the extendable resource
111 * @param strExtendableResourceType
112 * The extendable resource type
113 * @param request
114 * the request
115 */
116 void doCancelFavorite( LuteceUser user, String strIdExtendableResource, String strExtendableResourceType, HttpServletRequest request );
117
118 /**
119 * Load.
120 *
121 * @param nIdFavorite
122 * the n id favorite
123 * @return the favorite
124 */
125 Favorite findByPrimaryKey( int nIdFavorite );
126
127 /**
128 * Select by resource.
129 *
130 * @param strIdExtendableResource
131 * the str id extendable resource
132 * @param strExtendableResourceType
133 * the str extendable resource type
134 * @return the favorite
135 */
136 Favorite findByResource( String strIdExtendableResource, String strExtendableResourceType );
137
138 /**
139 * Find by filter
140 *
141 * @param filter
142 * the filter
143 * @return list Favorite by filter
144 */
145 List<Favorite> findByFilter( FavoriteFilter filter );
146 }