1 /*
2 * Copyright (c) 2002-2022, City of 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.portal.business.search;
35
36 import fr.paris.lutece.util.ReferenceItem;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Map;
40
41 /**
42 *
43 * Interface ISearchParameterDAO Defines data access providers for search parameters
44 *
45 */
46 public interface ISearchParameterDAO
47 {
48 /**
49 * Gets the parameters defined by the specified key
50 *
51 * @param strParameterKey
52 * the parameter key
53 * @return the found parameter
54 */
55 ReferenceItem load( String strParameterKey );
56
57 /**
58 * Updates the value of an existing parameter
59 *
60 * @param param
61 * the parameter to store
62 */
63 void store( ReferenceItem param );
64
65 /**
66 * Gets a list of all search parameters
67 *
68 * @return all search parameters as a Map
69 */
70 Map<String, String> findAll( );
71
72 /**
73 * Gets a list of all search parameters
74 *
75 * @return all search parameters as a ReferenceList
76 */
77 ReferenceList selectParametersList( );
78 }