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.subscribe.service;
35
36 import fr.paris.lutece.plugins.subscribe.business.Subscription;
37 import fr.paris.lutece.portal.service.security.LuteceUser;
38
39 import java.util.Locale;
40
41 /**
42 * Interface of services that provide subscriptions to resources
43 */
44 public interface ISubscriptionProviderService
45 {
46 /**
47 * Get the name of the subscription provider.
48 *
49 * @return The name of the subscription provider
50 */
51 String getProviderName( );
52
53 /**
54 * Get the description of a subscription by its action key and the resource id associated with it
55 *
56 * @param user
57 * The user
58 * @param strSubscriptionKey
59 * The key of the subscription
60 * @param strIdSubscribedResource
61 * The id of the subscribed resource
62 * @param locale
63 * The locale to display the generated HTML in
64 * @return An HTML string that describes the subscription
65 */
66 String getSubscriptionHtmlDescription( LuteceUser user, String strSubscriptionKey, String strIdSubscribedResource, Locale locale );
67
68 String getSubscriptionHtmlDescriptionBis( LuteceUser user, String strSubscriptionKey, String strIdSubscribedResource, Locale locale, String userSub );
69
70 /**
71 * Check if a subscription can be automatically removed. If the subscription is removed, the method {@link #notifySubscriptionRemoval(Subscription)} of the
72 * provider of the subscription will be called
73 *
74 * @param user
75 * The user
76 * @param strSubscriptionKey
77 * The subscription key
78 * @param strIdSubscribedResource
79 * The id of the subscribed resource
80 * @return True if the subscription can be removed, false otherwise
81 */
82 boolean isSubscriptionRemovable( LuteceUser user, String strSubscriptionKey, String strIdSubscribedResource );
83
84 /**
85 * Get the URL to modify the subscription
86 *
87 * @param user
88 * The user
89 * @param strSubscriptionKey
90 * The key of the subscription
91 * @param strIdSubscribedResource
92 * The id of the subscribed resource
93 * @return The URL to modify the subscription, or null if the subscription can not be modified
94 */
95 String getUrlModifySubscription( LuteceUser user, String strSubscriptionKey, String strIdSubscribedResource );
96
97 /**
98 * Notify the provider that a subscription associated with it has been removed
99 *
100 * @param subscription
101 * The removed subscription
102 */
103 void notifySubscriptionRemoval( Subscription subscription );
104 }