fr.paris.lutece.plugins.mydashboard.service

Interface IMyDashboardComponent

All Superinterfaces:

Comparable<IMyDashboardComponent>

All Known Implementing Classes:

MyDashboardComponent, MyDashboardComponentMyDashboard, MyDashboardComponentNickname

public interface IMyDashboardComponent
extends Comparable<IMyDashboardComponent>

Interface for dashboard components. Each bean implementing this interface will add a dashboard

Method Summary

Modifier and Type	Method and Description
String	getComponentDescription(Locale locale) Get the description of the component
String	getComponentId() Gets the id of the dashboard component.
String	getDashboardData(javax.servlet.http.HttpServletRequest request) Gets dash board data for the current user
boolean	isAvailable(fr.paris.lutece.portal.service.security.LuteceUser user) Check if the dashboard is available or not for a given Lutece User

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getDashboardData

String getDashboardData(javax.servlet.http.HttpServletRequest request)

Gets dash board data for the current user

Parameters:

request - HttpServletRequest

Returns:

HTML content to insert into a dash board zone

getComponentId

String getComponentId()

Gets the id of the dashboard component. The id of the dashboard component must be unique for each dashboard component, and be less than 50 characters long.

Returns:

The id of the dashboard component

getComponentDescription

String getComponentDescription(Locale locale)

Get the description of the component

Parameters:

locale - The locale to display the description in

Returns:

The description of the component

isAvailable

boolean isAvailable(fr.paris.lutece.portal.service.security.LuteceUser user)

Check if the dashboard is available or not for a given Lutece User

Parameters:

user - The user

Returns:

True if the dashboard is available for the given user, false otherwise