Package org.xwiki.eventstream
Interface UntypedRecordableEventDescriptor
-
- All Superinterfaces:
RecordableEventDescriptor
public interface UntypedRecordableEventDescriptor extends RecordableEventDescriptor
This interface represents the descriptor of anUntypedRecordableEvent
. As anUntypedRecordableEvent
, UntypedRecordableEventDescriptors are registered- Since:
- 9.6RC1
- Version:
- $Id: e88e281f6434353f26595b40eb85fd41c47d7914 $
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.xwiki.eventstream.RecordableEventDescriptor
RecordableEventDescriptor.EventFilter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description DocumentReference
getAuthorReference()
Get aDocumentReference
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 bygetEventTriggers()
should trigger this particular event.default String
getTargetExpression()
String
getValidationExpression()
Gets the event validation expression.-
Methods inherited from interface org.xwiki.eventstream.RecordableEventDescriptor
getApplicationIcon, getApplicationId, getApplicationName, getDescription, getEventTitle, getEventType, getEventTypeIcon, getFilter, isEnabled
-
-
-
-
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 bygetEventTriggers()
should trigger this particular event.- Returns:
- the triggering object type
-
getAuthorReference
DocumentReference getAuthorReference()
Get aDocumentReference
to the author of the descriptor. This reference is useful when evaluating the output ofgetValidationExpression()
.- Returns:
- the author reference
-
getTargetExpression
default String getTargetExpression()
- Returns:
- the velocity template that generate the list of targets
- Since:
- 9.11.2, 10.0
-
-