1 /*
2 * Copyright (c) 2002-2017, 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.business;
35
36 import javax.servlet.http.HttpServletRequest;
37 import javax.servlet.http.HttpSession;
38
39 import fr.paris.lutece.util.ReferenceItem;
40
41 /**
42 *
43 * IMapProvider : map provider for Geolocation
44 *
45 */
46 public interface IMapProvider
47 {
48 /**
49 * Gets the key. This key <b>must be unique</b>.
50 *
51 * @return the key;
52 */
53 String getKey( );
54
55 /**
56 * Gets the displayed name
57 *
58 * @return the displayed name
59 */
60 String getDisplayedName( );
61
62 /**
63 * Gets the html code
64 *
65 * @return the html code
66 */
67 String getHtmlCode( );
68
69 /**
70 * Gets the html code for list result in Back Office
71 *
72 * @return the html code
73 */
74 String getBackListHtmlCode( );
75
76 /**
77 * Gets the html code for list result front office
78 *
79 * @return the html code
80 */
81 String getFrontListHtmlCode( );
82
83 /**
84 * Gets the html code for front office
85 *
86 * @return the html code
87 */
88 String getFrontHtmlCode( );
89
90 /**
91 * Builds a new {@link ReferenceItem} for the map provider
92 *
93 * @return the item created.
94 */
95 ReferenceItem toRefItem( );
96
97 /**
98 * Defines if map in bo and fo lists is supported
99 *
100 * @return <code>true</code> if a map can be generated (show on map button), <code>false</code> otherwise.
101 */
102 boolean isMapListSupported( );
103
104 /**
105 * returns the Parameter class contains all the parameters of the map
106 *
107 * @param nKey
108 * the key
109 * @return the Parameter
110 */
111 Object getParameter( int nKey );
112 }