fr.paris.lutece.portal.service.dashboard
Class DashboardComponent

java.lang.Object
  extended by fr.paris.lutece.portal.service.dashboard.DashboardComponent
All Implemented Interfaces:
java.lang.Comparable<DashboardComponent>
Direct Known Subclasses:
SiteDashboardComponent, SystemDashboardComponent, UserHeaderDashboardComponent, UsersDashboardComponent

public abstract class DashboardComponent
extends java.lang.Object
implements java.lang.Comparable<DashboardComponent>

Dashboard Component


Constructor Summary
DashboardComponent()
           
 
Method Summary
 int compareTo(DashboardComponent o)
          Compare component order
abstract  java.lang.String getDashboardData(AdminUser user)
          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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DashboardComponent

public DashboardComponent()
Method Detail

getDashboardData

public abstract java.lang.String getDashboardData(AdminUser user)
Gets dashboard data for a given user

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

getName

public java.lang.String getName()
Returns the Name

Returns:
The Name

setName

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

Parameters:
strName - The Name

getRight

public java.lang.String getRight()
Returns the Right

Returns:
The Right

setRight

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

Parameters:
strRight - The Right

getZone

public int getZone()
Returns the Zone

Returns:
The Zone

setZone

public void setZone(int nZone)
Sets the Zone

Parameters:
nZone - The Zone

getOrder

public int getOrder()
Returns the Order

Returns:
The Order

setOrder

public void setOrder(int nOrder)
Sets the Order

Parameters:
nOrder - The Order

getPlugin

public Plugin getPlugin()
Returns the Plugin

Returns:
The Plugin

setPlugin

public void setPlugin(Plugin plugin)
Sets the Plugin

Parameters:
plugin - The plugin

compareTo

public int compareTo(DashboardComponent o)
Compare component order

Specified by:
compareTo in interface java.lang.Comparable<DashboardComponent>
Parameters:
o - The component to compare to
Returns:
less than 0 if the order is lower, 0 if equals and greater than 0 if higher

isEnabled

public boolean isEnabled()
Tells if the component is enabled

Returns:
true if enabled


Copyright © 2010 Mairie de Paris. All Rights Reserved.