fr.paris.lutece.portal.service.dashboard

Interface IDashboardComponent

All Superinterfaces:

Comparable<IDashboardComponent>, Localizable

All Known Subinterfaces:

IAdminDashboardComponent

All Known Implementing Classes:

AdminDashboardComponent, AdminHomePageManagementComponent, AutoIncludeAdminDashboardComponent, DashboardComponent, EditorAdminDashboardComponent, FeaturesAdminDashboardComponent, SearchAdminDashboardComponent, SiteDashboardComponent, SystemDashboardComponent, UserHeaderDashboardComponent, UsersAdminDashboardComponent, UsersDashboardComponent, XslExportAdminDashboardComponent

public interface IDashboardComponent
extends Comparable<IDashboardComponent>, Localizable

IDashboardComponent

Method Summary

Modifier and Type	Method and Description
String	getDashboardData(AdminUser user, javax.servlet.http.HttpServletRequest request) Gets dashboard data for a given user
String	getDescription() Returns a localized description
String	getName() Returns the Name
int	getOrder() Returns the Order
Plugin	getPlugin() Returns the Plugin
String	getRight() Returns the Right
int	getZone() Returns the Zone
boolean	isEnabled() Tells if the component is enabled
void	setName(String strName) Sets the Name
void	setOrder(int nOrder) Sets the Order
void	setPlugin(Plugin plugin) Sets the Plugin
void	setRight(String strRight) Sets the Right
void	setZone(int nZone) Sets the Zone

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface fr.paris.lutece.portal.service.i18n.Localizable

setLocale

Method Detail

getDashboardData

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

String getName()

Returns the Name

Returns:

The Name

setName

void setName(String strName)

Sets the Name

Parameters:

strName - The Name

getRight

String getRight()

Returns the Right

Returns:

The Right

setRight

void setRight(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

getDescription

String getDescription()

Returns a localized description

Returns:

a localized description