fr.paris.lutece.portal.service.dashboard
Interface IDashboardComponent

All Superinterfaces:
java.lang.Comparable<IDashboardComponent>
All Known Subinterfaces:
IAdminDashboardComponent
All Known Implementing Classes:
AdminDashboardComponent, DashboardComponent, SearchAdminDashboardComponent, SiteDashboardComponent, SystemDashboardComponent, UserHeaderDashboardComponent, UsersAdminDashboardComponent, UsersDashboardComponent

public interface IDashboardComponent
extends java.lang.Comparable<IDashboardComponent>

IDashboardComponent


Method Summary
 java.lang.String getDashboardData(AdminUser user, javax.servlet.http.HttpServletRequest request)
          Gets dashboard data for a given user
 java.lang.String getName()
          Returns the Name
 int getOrder()
          Returns the Order
 Plugin getPlugin()
          Returns the Plugin
 java.lang.String getRight()
          Returns the Right
 int getZone()
          Returns the Zone
 boolean isEnabled()
          Tells if the component is enabled
 void setName(java.lang.String strName)
          Sets the Name
 void setOrder(int nOrder)
          Sets the Order
 void setPlugin(Plugin plugin)
          Sets the Plugin
 void setRight(java.lang.String strRight)
          Sets the Right
 void setZone(int nZone)
          Sets the Zone
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getDashboardData

java.lang.String getDashboardData(AdminUser user,
                                  javax.servlet.http.HttpServletRequest request)
Gets dashboard data for a given user

Parameters:
user - The user
request - HttpServletRequest
Returns:
HTML content to insert into a dashboard zone

getName

java.lang.String getName()
Returns the Name

Returns:
The Name

setName

void setName(java.lang.String strName)
Sets the Name

Parameters:
strName - The Name

getRight

java.lang.String getRight()
Returns the Right

Returns:
The Right

setRight

void setRight(java.lang.String strRight)
Sets the Right

Parameters:
strRight - The Right

getZone

int getZone()
Returns the Zone

Returns:
The Zone

setZone

void setZone(int nZone)
Sets the Zone

Parameters:
nZone - The Zone

getOrder

int getOrder()
Returns the Order

Returns:
The Order

setOrder

void setOrder(int nOrder)
Sets the Order

Parameters:
nOrder - The Order

getPlugin

Plugin getPlugin()
Returns the Plugin

Returns:
The Plugin

setPlugin

void setPlugin(Plugin plugin)
Sets the Plugin

Parameters:
plugin - The plugin

isEnabled

boolean isEnabled()
Tells if the component is enabled

Returns:
true if enabled


Copyright © 2011 Mairie de Paris. All Rights Reserved.