1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.filter.event.model

File WikiClassFilter.java

 

Code metrics

0
0
0
1
87
18
0
-
-
0
-

Classes

Class Line # Actions
WikiClassFilter 32 0 - 0 0
-1.0 -
 

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.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    * Class related events.
28    *
29    * @version $Id: fc946bb55c738b1e604b20b32996f92503e90935 $
30    * @since 6.2M1
31    */
 
32    public interface WikiClassFilter
33    {
34    /**
35    * @type {@link String}
36    * @since 9.0RC1
37    */
38    String PARAMETER_NAME = "name";
39   
40    /**
41    * @type {@link String}
42    */
43    String PARAMETER_CUSTOMCLASS = "customclass";
44   
45    /**
46    * @type {@link String}
47    */
48    String PARAMETER_CUSTOMMAPPING = "custommapping";
49   
50    /**
51    * @type {@link String}
52    */
53    String PARAMETER_SHEET_DEFAULTVIEW = "sheet_defaultview";
54   
55    /**
56    * @type {@link String}
57    */
58    String PARAMETER_SHEET_DEFAULTEDIT = "sheet_defaultedit";
59   
60    /**
61    * @type {@link String}
62    */
63    String PARAMETER_DEFAULTSPACE = "defaultspace";
64   
65    /**
66    * @type {@link String}
67    */
68    String PARAMETER_NAMEFIELD = "namefield";
69   
70    /**
71    * @type {@link String}
72    */
73    String PARAMETER_VALIDATIONSCRIPT = "validationscript";
74   
75    /**
76    * @param parameters the properties of the class
77    * @throws FilterException when failing to send event
78    */
79    void beginWikiClass(@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters)
80    throws FilterException;
81   
82    /**
83    * @param parameters the properties of the class
84    * @throws FilterException when failing to send event
85    */
86    void endWikiClass(@Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
87    }