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.plugins.genericattributes.business;
35
36 import java.io.Serializable;
37
38 import fr.paris.lutece.util.ReferenceItem;
39
40 /**
41 *
42 * IMapProvider : map provider for Geolocation <br >
43 * <ul>
44 * <li><code>getKey( )</code> must return the unique key.</li>
45 * <li><code>getDisplayedName( )</code> will be displayed in reference lists.</li>
46 * </ul>
47 */
48 public interface IMapProvider extends Serializable
49 {
50 /**
51 * Gets the key. This key <b>must be unique</b>.
52 *
53 * @return the key;
54 */
55 String getKey( );
56
57 /**
58 * Gets the displayed name
59 *
60 * @return the displayed name
61 */
62 String getDisplayedName( );
63
64 /**
65 * Gets the html template
66 *
67 * @return the html template
68 */
69 String getHtmlCode( );
70
71 /**
72 * Builds a new {@link ReferenceItem} for the map provider.<br >
73 * <code>key == getKey( )</code>, <code>value == getDisplayedName( )</code>
74 *
75 * @return the item created.
76 */
77 ReferenceItem toRefItem( );
78
79 /**
80 * returns the Parameter class contains all the parameters of the map
81 *
82 * @return the Parameter
83 */
84 Object getParameter( int nKey );
85 }