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

File WikiClassPropertyFilter.java

 

Code metrics

0
0
0
1
60
13
0
-
-
0
-

Classes

Class Line # Actions
WikiClassPropertyFilter 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 property related events.
28    *
29    * @version $Id: 800a595e0bf05c6c6ac4bb4159058c8cc704aa01 $
30    * @since 6.2M1
31    */
 
32    public interface WikiClassPropertyFilter
33    {
34    /**
35    * @param name the name of the property
36    * @param type the type of the property
37    * @param parameters the parameters of the property
38    * @throws FilterException when failing to send event
39    */
40    void beginWikiClassProperty(String name, String type,
41    @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
42   
43    /**
44    * @param name the name of the property
45    * @param type the type of the property
46    * @param parameters the parameters of the property
47    * @throws FilterException when failing to send event
48    */
49    void endWikiClassProperty(String name, String type,
50    @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
51   
52    /**
53    * @param name the name of the field
54    * @param value the value of the field
55    * @param parameters the properties of the field
56    * @throws FilterException when failing to send event
57    */
58    void onWikiClassPropertyField(String name, String value,
59    @Default(FilterEventParameters.DEFAULT) FilterEventParameters parameters) throws FilterException;
60    }