View Javadoc
1   /*
2    * Copyright (c) 2002-2014, 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  
35  package fr.paris.lutece.portal.service.dashboard;
36  
37  import java.util.Locale;
38  import java.util.Map;
39  
40  /**
41   * The Interface IDashboard.
42   */
43  public interface IPublicDashboardComponent {
44  
45  	/**
46  	 * Gets the description.
47  	 *@param locale
48  	 * @return the description
49  	 */
50  	String getComponentDescription( Locale locale );
51  	
52  	/**
53       * Gets the id of the dashboard component.
54       * @return The id of the dashboard component
55       */
56  	String getComponentId( );
57  	
58  	/**
59  	 * Get the location of the template
60  	 * 
61  	 * @return the template
62  	 */
63  	String getDashboardTemplate( );
64  	
65  	/**
66  	 * Get the model filled with the data of the dashboard
67  	 * 
68  	 * @param user_id
69  	 * @param additionalParameters
70  	 * @return the model filled
71  	 */
72  	Map<String, Object> getDashboardModel( String user_id, Map<String,String[]> additionalParameters );
73  	
74  
75  }