org.xwiki.eventstream

Interface RecordableEventDescriptorManager

@Role
public interface RecordableEventDescriptorManager

Get all RecordableEventDescriptors that are present in the wiki.

Since:

9.2RC1

Version:

$Id: 94a117e566aa0a143c9eb8421d821b3daf53a9fa $

Method Summary

Modifier and Type	Method and Description
RecordableEventDescriptor	getDescriptorForEventType(String eventType, boolean allWikis)
List<RecordableEventDescriptor>	getRecordableEventDescriptors(boolean allWikis)

Method Detail

getRecordableEventDescriptors

List<RecordableEventDescriptor> getRecordableEventDescriptors(boolean allWikis)
                                                       throws EventStreamException

Parameters:

allWikis - load the descriptors from all the wikis of the farm if true

Returns:

all the available implementation of RecordableEventDescriptor

Throws:

EventStreamException - if an error occurs

Since:

9.5.1, 9.6RC1

getDescriptorForEventType

RecordableEventDescriptor getDescriptorForEventType(String eventType,
                                                    boolean allWikis)
                                             throws EventStreamException

Parameters:

eventType - the type of the event

allWikis - load the descriptors from all the wikis of the farm if true

Returns:

the corresponding RecordableEventDescriptor or null if no one matches

Throws:

EventStreamException - if an error happens

Since:

9.10RC1