fr.paris.lutece.plugins.directory.business
Interface IMapProvider

All Known Implementing Classes:
MapProvider

public interface IMapProvider

IMapProvider : map provider for Geolocation


Method Summary
 java.lang.String getBackListHtmlCode()
          Gets the html code for list result in Back Office
 java.lang.String getDisplayedName()
          Gets the displayed name
 java.lang.String getFrontHtmlCode()
          Gets the html code for front office
 java.lang.String getFrontListHtmlCode()
          Gets the html code for list result front office
 java.lang.String getHtmlCode()
          Gets the html code
 java.lang.String getKey()
          Gets the key.
 boolean isMapListSupported()
          Defines if map in bo and fo lists is supported
 fr.paris.lutece.util.ReferenceItem toRefItem()
          Builds a new ReferenceItem for the map provider
 

Method Detail

getKey

java.lang.String getKey()
Gets the key. This key must be unique.

Returns:
the key;

getDisplayedName

java.lang.String getDisplayedName()
Gets the displayed name

Returns:
the displayed name

getHtmlCode

java.lang.String getHtmlCode()
Gets the html code

Returns:
the html code

getBackListHtmlCode

java.lang.String getBackListHtmlCode()
Gets the html code for list result in Back Office

Returns:
the html code

getFrontListHtmlCode

java.lang.String getFrontListHtmlCode()
Gets the html code for list result front office

Returns:
the html code

getFrontHtmlCode

java.lang.String getFrontHtmlCode()
Gets the html code for front office

Returns:
the html code

toRefItem

fr.paris.lutece.util.ReferenceItem toRefItem()
Builds a new ReferenceItem for the map provider

Returns:
the item created.

isMapListSupported

boolean isMapListSupported()
Defines if map in bo and fo lists is supported

Returns:
true if a map can be generated (show on map button), false otherwise.


Copyright © 2012 Mairie de Paris. All Rights Reserved.