View Javadoc

1   /***
2    * ReportFilter.java
3    *
4    * This file is part of the creme library.
5    * The creme library intends to ease the development effort of large
6    * applications by providing easy to use support classes.
7    *
8    * Copyright (C) 2002 Denis Bregeon
9    *
10   * This library is free software; you can redistribute it and/or
11   * modify it under the terms of the GNU Lesser General Public
12   * License as published by the Free Software Foundation; either
13   * version 2.1 of the License, or (at your option) any later version.
14   *
15   * This library is distributed in the hope that it will be useful,
16   * but WITHOUT ANY WARRANTY; without even the implied warranty of
17   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18   * Lesser General Public License for more details.
19   *
20   * You should have received a copy of the GNU Lesser General Public
21   * License along with this library; if not, write to the Free Software
22   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23   *
24   * contact information: dbregeon@sourceforge.net
25   */
26  package org.jcreme.filters;
27  
28  /***
29   * This interface decribes the properties of a generic ReportFilter. A
30   * ReportFilter is basically a filter that can be listened. This is necessary so
31   * that reports can be updated when the filter they use is changed.
32   * 
33   * @author $Author: dbregeon $
34   * @version $Revision: 1.1 $
35   */
36  public interface ReportFilter extends Filter {
37      /***
38       * This enables to add a listener for the changes of the filter.
39       * 
40       * @param listener
41       *            the object that will react to the modifications.
42       */
43      public void addFilterChangeListener(FilterChangeListener listener);
44  
45      /***
46       * This enables to remove a listener for the changes of the filter.
47       * 
48       * @param listener
49       *            the listener to remove.
50       */
51      public void removeFilterChangeListener(FilterChangeListener listener);
52  }
53