Package org.xwiki.eventstream

Interface RecordableEventDescriptor

All Known Subinterfaces:

UntypedRecordableEventDescriptor

All Known Implementing Classes:

AbstractRecordableEventDescriptor

@Role
public interface RecordableEventDescriptor

Provide a description for a specific implementation of RecordableEvent so that users can know what the event is about.

Since:

9.2RC1

Version:

$Id: 9a760f00fdf1dc49ba298ef4fde896b86eff4ecd $

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RecordableEventDescriptor.EventFilter	The different filters we support to retrieve event.

Method Summary

Modifier and Type	Method	Description
String	getApplicationIcon()
default String	getApplicationId()
String	getApplicationName()
String	getDescription()
default String	getEventTitle()
String	getEventType()
default String	getEventTypeIcon()
default RecordableEventDescriptor.EventFilter	getFilter()
default boolean	isEnabled(String wikiId)

Method Detail

getEventType

String getEventType()

Returns:

the name of the event described by the descriptor, as it is stored in the event stream.

getApplicationId

default String getApplicationId()

Returns:

the id of the application that provide this event

Since:

9.6RC1

getApplicationName

String getApplicationName()

Returns:

the name of the application that provide this event

getDescription

String getDescription()

Returns:

the description of the event type

getApplicationIcon

String getApplicationIcon()

Returns:

the icon corresponding to the application

getFilter

default RecordableEventDescriptor.EventFilter getFilter()

Returns:

the kind of filter to use for this event type

Since:

9.4RC1

getEventTypeIcon

default String getEventTypeIcon()

Returns:

the id of the application that provide this event

Since:

9.10RC1

isEnabled

default boolean isEnabled(String wikiId)

Parameters:

wikiId - id of the wiki

Returns:

either or not the descriptor is enabled in the given wiki

Since:

10.5RC1, 9.11.6

getEventTitle

default String getEventTitle()

Returns:

the title of the event to be used in notifications. The returned value should be preferably a translation key.

Since:

12.9RC1