org.xwiki.eventstream

Interface EventStatusManager

@Role
public interface EventStatusManager

Handle the statuses for the events.

Since:

9.2RC1

Version:

$Id: d168fdd726a16bb6d71c5e8fb30f3417073da191 $

Method Summary

Modifier and Type	Method and Description
default void	deleteAllForEntity(Date startDate, String entityId) Deprecated. since 12.6, use EventStore.deleteEventStatuses(String, Date) instead
default void	deleteEventStatus(EventStatus eventStatus) Deprecated. since 12.5RC1, use EventStore.deleteEventStatus(EventStatus) instead
List<EventStatus>	getEventStatus(List<Event> events, List<String> entityIds) Get the list of statuses concerning the given events and the given entities.
void	saveEventStatus(EventStatus eventStatus) Deprecated. since 12.3RC1, use EventStore.saveEventStatus(EventStatus) instead

Method Detail

getEventStatus

List<EventStatus> getEventStatus(List<Event> events,
                                 List<String> entityIds)
                          throws Exception

Get the list of statuses concerning the given events and the given entities.

Parameters:

events - a list of events

entityIds - a list of ids of entities (users and groups)

Returns:

the list of statuses corresponding to each pair or event/entity

Throws:

Exception - if an error occurs

saveEventStatus

@Deprecated
void saveEventStatus(EventStatus eventStatus)
                          throws Exception

Deprecated. since 12.3RC1, use EventStore.saveEventStatus(EventStatus) instead

Save in the storage the given status.

Parameters:

eventStatus - the status to save

Throws:

Exception - if an error occurs

deleteEventStatus

@Deprecated
default void deleteEventStatus(EventStatus eventStatus)
                                    throws Exception

Deprecated. since 12.5RC1, use EventStore.deleteEventStatus(EventStatus) instead

Delete from the storage the given status.

Parameters:

eventStatus - the status to save

Throws:

Exception - if an error occurs

Since:

12.5RC1

deleteAllForEntity

@Deprecated
default void deleteAllForEntity(Date startDate,
                                            String entityId)
                                     throws Exception

Deprecated. since 12.6, use EventStore.deleteEventStatuses(String, Date) instead

Parameters:

startDate - date before which to remove event status

entityId - the id of the entity concerned by the status

Throws:

Exception - if an error occurs

Since:

12.1RC1