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 javax.servlet.http.HttpServletRequest;
38  
39  import fr.paris.lutece.portal.service.security.LuteceUser;
40  
41  public interface IMyDashboardComponent extends Comparable<IMyDashboardComponent> {
42  
43  	/**
44  	 * Gets the dashboard data.
45  	 *
46  	 * @param request the request
47  	 * @return the dashboard data
48  	 */
49  	String getDashboardData( HttpServletRequest request );
50  	
51  	/**
52  	 * Gets the description.
53  	 *
54  	 * @return the description
55  	 */
56  	String getComponentDescription( );
57  	
58  	/**
59       * Gets the id of the dashboard component.
60       * @return The id of the dashboard component
61       */
62  	String getComponentId( );
63  	
64  	/**
65       * Check if the dashboard is available or not for a given Lutece User
66       * @param user The user
67       * @return True if the dashboard is available for the given user, false
68       *         otherwise
69       */
70      boolean isAvailable( LuteceUser user );
71  }