org.xwiki.eventstream
Interface EventStream


@Role
public interface EventStream

The stream of events, allowing to store and retrieve events.

Since:
3.0M2
Version:
$Id: f643258028180a2ee69d188fe1692c3f6ce17494 $

Method Summary
 void addEvent(Event e)
          Add a new event to the storage.
 void deleteEvent(Event e)
          Delete an event from the storage.
 EventGroup getRelatedEvents(Event e)
          Retrieve the group that a given event is part of.
 List<Event> searchEvents(Query query)
          Search stored events.
 

Method Detail

addEvent

void addEvent(Event e)
Add a new event to the storage.

Parameters:
e - the event to store

searchEvents

List<Event> searchEvents(Query query)
                         throws QueryException
Search stored events. The query will be prefixed with a hardcoded select event from Event as event or equivalent stub which selects actual events from the storage, so it must start with further from or where statements.

Parameters:
query - a query stub
Returns:
the list of events matched by the query
Throws:
QueryException - if the query is malformed or cannot be executed

getRelatedEvents

EventGroup getRelatedEvents(Event e)
Retrieve the group that a given event is part of.

Parameters:
e - the event to search for
Returns:
the event's group of related events

deleteEvent

void deleteEvent(Event e)
Delete an event from the storage. This method does not perform any rights check, it should be done before calling this method.

Parameters:
e - the event to delete


Copyright © 2004-2013 XWiki. All Rights Reserved.