org.xwiki.eventstream

Interface UntypedRecordableEventDescriptor

All Superinterfaces:

RecordableEventDescriptor

@Unstable
public interface UntypedRecordableEventDescriptor
extends RecordableEventDescriptor

This interface represents the descriptor of an UntypedRecordableEvent. As an UntypedRecordableEvent, UntypedRecordableEventDescriptors are registered

Since:

9.6RC1

Version:

$Id: 3c03c4120672d3ac24094b70a124bc05b346f3b4 $

Nested Class Summary

Nested classes/interfaces inherited from interface org.xwiki.eventstream.RecordableEventDescriptor

RecordableEventDescriptor.EventFilter

Method Summary

Modifier and Type	Method and Description
DocumentReference	getAuthorReference() Get a DocumentReference to the author of the descriptor.
List<String>	getEventTriggers() Get a list of the events that should trigger this particular event.
List<String>	getObjectTypes() Get the object that, associated with one of the events returned by getEventTriggers() should trigger this particular event.
String	getValidationExpression() Gets the event validation expression.

Methods inherited from interface org.xwiki.eventstream.RecordableEventDescriptor

getApplicationIcon, getApplicationId, getApplicationName, getDescription, getEventType, getEventTypeIcon, getFilter

Method Detail

getValidationExpression

String getValidationExpression()

Gets the event validation expression. This expression is a macro that, once rendered, should return "true" in order to trigger the associated event.

Returns:

the validation expression

getEventTriggers

List<String> getEventTriggers()

Get a list of the events that should trigger this particular event. Each event is represented by its canonical name.

Returns:

the event trigger list

getObjectTypes

List<String> getObjectTypes()

Get the object that, associated with one of the events returned by getEventTriggers() should trigger this particular event.

Returns:

the triggering object type

getAuthorReference

DocumentReference getAuthorReference()

Get a DocumentReference to the author of the descriptor. This reference is useful when evaluating the output of getValidationExpression().

Returns:

the author reference