View Javadoc
1   /*
2    * Copyright (c) 2002-2018, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter;
35  
36  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.RecordParameters;
37  import fr.paris.lutece.plugins.directory.modules.multiview.business.record.filter.configuration.RecordFilterConfiguration;
38  
39  /**
40   * Interface for a RecordFilter object
41   */
42  public interface IRecordFilter
43  {
44      /**
45       * Return the RecordParameters of the RecordFilter
46       * 
47       * @return the RecordParameters of the RecordFilter
48       */
49      RecordParameters getRecordParameters( );
50  
51      /**
52       * Set the RecordParameters to the RecordFilter
53       * 
54       * @param recordParameters
55       *            The RecordParameters to set to the RecordFilter
56       */
57      void setRecordParameters( RecordParameters recordParameters );
58  
59      /**
60       * Return the RecordFilterConfiguration of the RecordFilter
61       * 
62       * @return the RecordFilterConfiguration of the RecordFilter
63       */
64      RecordFilterConfiguration getRecordFilterConfiguration( );
65  
66      /**
67       * Set the RecordFilterConfiguration of the RecordFilter
68       * 
69       * @param recordFilterConfiguration
70       *            The RecordFilterConfiguration to set for the RecordFilter
71       */
72      void setRecordFilterConfiguration( RecordFilterConfiguration recordFilterConfiguration );
73  }