Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiObjectFilter | 32 | 0 | - | 0 | 0 |
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.filter.event.model; | |
21 | ||
22 | import org.xwiki.filter.FilterEventParameters; | |
23 | import org.xwiki.filter.FilterException; | |
24 | import org.xwiki.filter.annotation.Default; | |
25 | ||
26 | /** | |
27 | * Object related events. | |
28 | * | |
29 | * @version $Id: 74e5e92b0d28eae098bc5a2f8690bb0cabcc0af9 $ | |
30 | * @since 6.2M1 | |
31 | */ | |
32 | public interface WikiObjectFilter | |
33 | { | |
34 | /** | |
35 | * @type {@link String} | |
36 | * @since 9.0RC1 | |
37 | */ | |
38 | String PARAMETER_NAME = "name"; | |
39 | ||
40 | /** | |
41 | * @type {@link Integer} | |
42 | */ | |
43 | String PARAMETER_NUMBER = "number"; | |
44 | ||
45 | /** | |
46 | * @type {@link String} | |
47 | */ | |
48 | String PARAMETER_CLASS_REFERENCE = "class_reference"; | |
49 | ||
50 | /** | |
51 | * @type {@link String} | |
52 | */ | |
53 | String PARAMETER_GUID = "guid"; | |
54 | ||
55 | /** | |
56 | * @param name the name of the object | |
57 | * @param parameters the properties of the object | |
58 | * @throws FilterException when failing to send event | |
59 | */ | |
60 | void beginWikiObject(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) | |
61 | throws FilterException; | |
62 | ||
63 | /** | |
64 | * @param name the name of the object | |
65 | * @param parameters the properties of the object | |
66 | * @throws FilterException when failing to send event | |
67 | */ | |
68 | void endWikiObject(String name, @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) | |
69 | throws FilterException; | |
70 | } |