1 /*
2 * Copyright (c) 2002-2023, 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.broadcastproxy.business;
35
36 import java.util.List;
37 import java.util.Map;
38
39 import org.json.simple.JSONObject;
40
41 public interface IBroadcastProvider
42 {
43
44 /**
45 * get provider name
46 *
47 * @return
48 */
49 String getName( );
50
51 /**
52 * update user subscriptions to the specified subscription list
53 *
54 * @param subscriptionsList
55 * @param strAccountId
56 * @return true if success
57 * @throws java.lang.Exception
58 */
59 boolean updateSubscribtions( String userId, String jsonSubscriptions, String strAccountId ) throws Exception;
60
61 /**
62 * update user subscriptions to the specified subscription list
63 *
64 * @param subscriptionsList
65 * @param strAccountId
66 * @return true if success
67 * @throws java.lang.Exception
68 */
69 boolean updateArrondissementSubscribtions( String userId, String jsonSubscriptions, String strAccountId ) throws Exception;
70
71 /**
72 * update user subscriptions to the specified subscription list
73 *
74 * @param subscriptionsList
75 * @return true if success
76 * @throws java.lang.Exception
77 */
78 boolean updateSubscribtions( String userId, List<Subscription> subscriptionsList ) throws Exception;
79
80 /**
81 * update user subscription
82 *
83 * @param subscription
84 * @param strAccountId
85 * @return true if success
86 * @throws java.lang.Exception
87 */
88 boolean update( Subscription subscription, String strAccountId ) throws Exception;
89
90 /**
91 * get feed list
92 *
93 * @return the list
94 */
95 List<Feed> getFeeds( );
96
97
98 /**
99 * get all subscription by group
100 * @param typeSubscription
101 * @param strAccountId
102 * @return
103 * @throws Exception
104 */
105 String getAllSubscriptionByGroup( String typeSubscription, String strAccountId );
106
107 /**
108 * get user subscriptions ids
109 * @param strUserId
110 * @param strAccountId
111 * @return list of user subscription ids
112 */
113 List<JSONObject> getUserSubscriptionIds ( String strUserId, String strAccountId );
114
115 }