1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.eventstream

File UntypedRecordableEventDescriptor.java

 

Coverage histogram

../../../img/srcFileCovDistChart0.png
86% of files have more coverage

Code metrics

0
1
1
1
75
13
1
1
1
1
1

Classes

Class Line # Actions
UntypedRecordableEventDescriptor 33 1 0% 1 2
0.00%
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.eventstream;
21   
22    import java.util.List;
23   
24    import org.xwiki.model.reference.DocumentReference;
25   
26    /**
27    * This interface represents the descriptor of an {@link UntypedRecordableEvent}. As an {@link UntypedRecordableEvent},
28    * UntypedRecordableEventDescriptors are registered
29    *
30    * @version $Id: 348ea25d6e9d5586181ee8564fdf82b96048968b $
31    * @since 9.6RC1
32    */
 
33    public interface UntypedRecordableEventDescriptor extends RecordableEventDescriptor
34    {
35    /**
36    * Gets the event validation expression. This expression is a macro that, once rendered, should return "true" in
37    * order to trigger the associated event.
38    *
39    * @return the validation expression
40    */
41    String getValidationExpression();
42   
43    /**
44    * Get a list of the events that should trigger this particular event. Each event is represented by its canonical
45    * name.
46    *
47    * @return the event trigger list
48    */
49    List<String> getEventTriggers();
50   
51    /**
52    * Get the object that, associated with one of the events returned by {@link #getEventTriggers()} should trigger
53    * this particular event.
54    *
55    * @return the triggering object type
56    */
57    List<String> getObjectTypes();
58   
59    /**
60    * Get a {@link DocumentReference} to the author of the descriptor. This reference is useful when evaluating
61    * the output of {@link #getValidationExpression()}.
62    *
63    * @return the author reference
64    */
65    DocumentReference getAuthorReference();
66   
67    /**
68    * @return the velocity template that generate the list of targets
69    * @since 9.11.2
70    * @since 10.0
71    */
 
72  0 toggle default String getTargetExpression() {
73  0 return null;
74    }
75    }