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.web.record.filter.display;
35
36 import javax.servlet.http.HttpServletRequest;
37
38 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.filter.IFilterable;
39 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.util.IRecordListPosition;
40
41 /**
42 * Interface for the Filter associated to a RecordColumnDisplay
43 */
44 public interface IRecordFilterDisplay extends IFilterable, IRecordListPosition
45 {
46 /**
47 * Return the value of the RecordFilterDisplay
48 *
49 * @return the value of the RecordFilterDisplay
50 */
51 String getValue( );
52
53 /**
54 * Return the name of the parameter associated to the RecordFilterDisplay. This name correspond to the name on which the filter used to retrieve the value
55 * which has been selected on the screen by the user. If the name returned by this method doesn't match the name used to retrieve the value selected by the
56 * user this value will be lost during the redirection between the page of the details of the records and the page which list all the records.
57 *
58 * @return the name of the parameter associated to the RecordFilterDisplay
59 */
60 String getParameterName( );
61
62 /**
63 * Return the template of the RecordFilterDisplay
64 *
65 * @return the template of the RecordFilterDisplay
66 */
67 String getTemplate( );
68
69 /**
70 * Build the Template of the RecordFilterDisplay
71 *
72 * @param request
73 * The HttpServletRequest to use to build the template of the filter
74 */
75 void buildTemplate( HttpServletRequest request );
76 }