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