Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WatchListNotifier | 37 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.watchlist.internal.api; | |
21 | ||
22 | import java.util.Collection; | |
23 | import java.util.Date; | |
24 | import java.util.List; | |
25 | import java.util.Map; | |
26 | ||
27 | import org.xwiki.component.annotation.Role; | |
28 | ||
29 | import com.xpn.xwiki.XWikiException; | |
30 | ||
31 | /** | |
32 | * Component that sends notifications to users. | |
33 | * | |
34 | * @version $Id: 4ef689cbbb9d62ebb35a299c5a53eac0727390e5 $ | |
35 | */ | |
36 | @Role | |
37 | public interface WatchListNotifier | |
38 | { | |
39 | /** | |
40 | * Sends out a notification to the subscriber that certain events occurred. | |
41 | * | |
42 | * @param subscriber user to notify | |
43 | * @param events list of events | |
44 | * @param templateDocument the document which contains the template to use for the message that is being sent | |
45 | * @param previousFireTime last time the notification was fired | |
46 | * @throws XWikiException if mail sending fails | |
47 | * @deprecated since 7.1M1 | |
48 | */ | |
49 | @Deprecated | |
50 | void sendNotification(String subscriber, List<WatchListEvent> events, String templateDocument, | |
51 | Date previousFireTime) throws XWikiException; | |
52 | ||
53 | /** | |
54 | * @param subscribers the list of users to notify | |
55 | * @param events the list of events that occurred in a certain amount of time and of which the subscribers *might* | |
56 | * be interested. The actual events each subscriber is interested in and that he will be notified of will | |
57 | * be computed in the background | |
58 | * @param notificationData a map of additional data about this notification (e.g. "previousFireTime", etc.) | |
59 | * @throws WatchListException if problems occur | |
60 | */ | |
61 | void sendNotification(Collection<String> subscribers, List<WatchListEvent> events, | |
62 | Map<String, Object> notificationData) throws WatchListException; | |
63 | } |