1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.eventstream

File EventStatusManager.java

 

Code metrics

0
0
0
1
52
9
0
-
-
0
-

Classes

Class Line # Actions
EventStatusManager 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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.eventstream;
21   
22    import java.util.List;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * Handle the statuses for the events.
28    *
29    * @version $Id: 510122c1fc3eabe0f7dbec6e57c1de0f3c6cc0ac $
30    * @since 9.2RC1
31    */
32    @Role
 
33    public interface EventStatusManager
34    {
35    /**
36    * Get the list of statuses concerning the given events and the given entities.
37    *
38    * @param events a list of events
39    * @param entityIds a list of ids of entities (users and groups)
40    * @return the list of statuses corresponding to each pair or event/entity
41    *
42    * @throws Exception if an error occurs
43    */
44    List<EventStatus> getEventStatus(List<Event> events, List<String> entityIds) throws Exception;
45   
46    /**
47    * Save in the storage the given status.
48    * @param eventStatus the status to save
49    * @throws Exception if an error occurs
50    */
51    void saveEventStatus(EventStatus eventStatus) throws Exception;
52    }