A C D E G O S T V

A

addEvent(Event) - Method in interface org.xwiki.eventstream.EventStream

Add a new event to the storage.

addEvents(Event...) - Method in class org.xwiki.eventstream.EventGroup

Add more events to this group.

C

clearEvents() - Method in class org.xwiki.eventstream.EventGroup

Remove all the events from this group.

createEvent() - Method in interface org.xwiki.eventstream.EventFactory

Create a new event with some fields already filled in.

createEvent() - Method in class org.xwiki.eventstream.internal.DefaultEventFactory

Create a new event with some fields already filled in.

createRawEvent() - Method in interface org.xwiki.eventstream.EventFactory

Create a new event without any of the fields filled in.

createRawEvent() - Method in class org.xwiki.eventstream.internal.DefaultEventFactory

Create a new event without any of the fields filled in.

D

DefaultEvent - Class in org.xwiki.eventstream.internal

A recorded event that occurred at some point in the wiki.

DefaultEvent() - Constructor for class org.xwiki.eventstream.internal.DefaultEvent

DefaultEventFactory - Class in org.xwiki.eventstream.internal

Default implementation of the EventFactory, creating DefaultEvent objects as events.

DefaultEventFactory() - Constructor for class org.xwiki.eventstream.internal.DefaultEventFactory

deleteEvent(Event) - Method in interface org.xwiki.eventstream.EventStream

Delete an event from the storage.

E

Event - Interface in org.xwiki.eventstream

A recorded event that occurred at some point in the wiki.

Event.Importance - Enum in org.xwiki.eventstream

The importance of an event.

EventFactory - Interface in org.xwiki.eventstream

A factory which creates Event objects ready to be used.

EventGroup - Class in org.xwiki.eventstream

A group of related events, all happening as a consequence of the same action.

EventGroup() - Constructor for class org.xwiki.eventstream.EventGroup

Default constructor that creates an empty event group.

EventGroup(List<Event>) - Constructor for class org.xwiki.eventstream.EventGroup

Constructor that creates a group containing the passed events.

EventGroup(Set<Event>) - Constructor for class org.xwiki.eventstream.EventGroup

Constructor that creates a group containing the passed events.

EventGroup(Event...) - Constructor for class org.xwiki.eventstream.EventGroup

Constructor that creates a group containing the passed events.

EventStream - Interface in org.xwiki.eventstream

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

G

getApplication() - Method in interface org.xwiki.eventstream.Event

Events can be triggered by different applications, not only the main wiki update events: user statuses, blog pingbacks, new extension added...

getApplication() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Events can be triggered by different applications, not only the main wiki update events: user statuses, blog pingbacks, new extension added...

getBody() - Method in interface org.xwiki.eventstream.Event

A larger section of text where the event can store some data.

getBody() - Method in class org.xwiki.eventstream.internal.DefaultEvent

A larger section of text where the event can store some data.

getDate() - Method in interface org.xwiki.eventstream.Event

An event happens at a precise date.

getDate() - Method in class org.xwiki.eventstream.internal.DefaultEvent

An event happens at a precise date.

getDocument() - Method in interface org.xwiki.eventstream.Event

Document-related events target a certain document.

getDocument() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Document-related events target a certain document.

getDocumentTitle() - Method in interface org.xwiki.eventstream.Event

The document title is usually more important than the document name.

getDocumentTitle() - Method in class org.xwiki.eventstream.internal.DefaultEvent

The document title is usually more important than the document name.

getDocumentVersion() - Method in interface org.xwiki.eventstream.Event

For events related to documents, this field records the version of the document at the time when the event occurred.

getDocumentVersion() - Method in class org.xwiki.eventstream.internal.DefaultEvent

For events related to documents, this field records the version of the document at the time when the event occurred.

getEvents() - Method in class org.xwiki.eventstream.EventGroup

List the events that are part of this group.

getGroupId() - Method in interface org.xwiki.eventstream.Event

Multiple events can correspond to the same activity, so events can be grouped under the same GroupID.

getGroupId() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Multiple events can correspond to the same activity, so events can be grouped under the same GroupID.

getId() - Method in interface org.xwiki.eventstream.Event

Each event has a unique ID.

getId() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Each event has a unique ID.

getImportance() - Method in interface org.xwiki.eventstream.Event

Different events can have a different importance.

getImportance() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Different events can have a different importance.

getMainEvent() - Method in class org.xwiki.eventstream.EventGroup

Get the most important event in this group.

getRelatedEntity() - Method in interface org.xwiki.eventstream.Event

Some events may be related to a more specific entity in the target document, like an attachment or an object, or may relate to another document besides the main related document.

getRelatedEntity() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Some events may be related to a more specific entity in the target document, like an attachment or an object, or may relate to another document besides the main related document.

getRelatedEvents(Event) - Method in interface org.xwiki.eventstream.EventStream

Retrieve the group that a given event is part of.

getSpace() - Method in interface org.xwiki.eventstream.Event

Document-related events target a certain document, and documents belong to a space; this is the space of the target document.

getSpace() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Document-related events target a certain document, and documents belong to a space; this is the space of the target document.

getStream() - Method in interface org.xwiki.eventstream.Event

Events can happen in different contexts; for example, wiki activity events happen in different spaces, user statuses are targeted to different groups.

getStream() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Events can happen in different contexts; for example, wiki activity events happen in different spaces, user statuses are targeted to different groups.

getTitle() - Method in interface org.xwiki.eventstream.Event

A name for the event.

getTitle() - Method in class org.xwiki.eventstream.internal.DefaultEvent

A name for the event.

getType() - Method in interface org.xwiki.eventstream.Event

Events have different types: adding a comment, updating an attachment, importing an application, etc.

getType() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Events have different types: adding a comment, updating an attachment, importing an application, etc.

getUrl() - Method in interface org.xwiki.eventstream.Event

If an event happens in an URL-accessible location (a document), or if the event itself can be seen at a given URL, this field stores that URL.

getUrl() - Method in class org.xwiki.eventstream.internal.DefaultEvent

If an event happens in an URL-accessible location (a document), or if the event itself can be seen at a given URL, this field stores that URL.

getUser() - Method in interface org.xwiki.eventstream.Event

Event usually occur as the result of a registered user activity.

getUser() - Method in class org.xwiki.eventstream.internal.DefaultEvent

Event usually occur as the result of a registered user activity.

getWiki() - Method in interface org.xwiki.eventstream.Event

In a wiki farm, each event happens in one of the wikis.

getWiki() - Method in class org.xwiki.eventstream.internal.DefaultEvent

In a wiki farm, each event happens in one of the wikis.

O

org.xwiki.eventstream - package org.xwiki.eventstream

org.xwiki.eventstream.internal - package org.xwiki.eventstream.internal

S

searchEvents(Query) - Method in interface org.xwiki.eventstream.EventStream

Search stored events.

setApplication(String) - Method in interface org.xwiki.eventstream.Event

setApplication(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setBody(String) - Method in interface org.xwiki.eventstream.Event

setBody(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setDate(Date) - Method in interface org.xwiki.eventstream.Event

setDate(Date) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setDocument(DocumentReference) - Method in interface org.xwiki.eventstream.Event

setDocument(DocumentReference) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setDocumentTitle(String) - Method in interface org.xwiki.eventstream.Event

setDocumentTitle(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setDocumentVersion(String) - Method in interface org.xwiki.eventstream.Event

setDocumentVersion(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setGroupId(String) - Method in interface org.xwiki.eventstream.Event

setGroupId(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setId(String) - Method in interface org.xwiki.eventstream.Event

setId(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setImportance(Event.Importance) - Method in interface org.xwiki.eventstream.Event

setImportance(Event.Importance) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setRelatedEntity(EntityReference) - Method in interface org.xwiki.eventstream.Event

setRelatedEntity(EntityReference) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setSpace(SpaceReference) - Method in interface org.xwiki.eventstream.Event

setSpace(SpaceReference) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setStream(String) - Method in interface org.xwiki.eventstream.Event

setStream(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setTitle(String) - Method in interface org.xwiki.eventstream.Event

setTitle(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setType(String) - Method in interface org.xwiki.eventstream.Event

setType(String) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setUrl(URL) - Method in interface org.xwiki.eventstream.Event

setUrl(URL) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setUser(DocumentReference) - Method in interface org.xwiki.eventstream.Event

setUser(DocumentReference) - Method in class org.xwiki.eventstream.internal.DefaultEvent

setWiki(WikiReference) - Method in interface org.xwiki.eventstream.Event

setWiki(WikiReference) - Method in class org.xwiki.eventstream.internal.DefaultEvent

T

toString() - Method in class org.xwiki.eventstream.EventGroup

toString() - Method in class org.xwiki.eventstream.internal.DefaultEvent

V

valueOf(String) - Static method in enum org.xwiki.eventstream.Event.Importance

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.xwiki.eventstream.Event.Importance

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G O S T V