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