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

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

public abstract class DashboardComponent
extends java.lang.Object
implements IDashboardComponent

Dashboard Component


Constructor Summary
DashboardComponent()
           
 
Method Summary
 int compareTo(IDashboardComponent o)
          Compare component order
 boolean equals(java.lang.Object obj)
          
 java.lang.String getDashboardData(AdminUser user)
          Gets dashboard data for a given user
 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
 int hashCode()
          
 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
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DashboardComponent

public DashboardComponent()
Method Detail

getDashboardData

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

Specified by:
getDashboardData in interface IDashboardComponent
Parameters:
user - The user
request - HttpServletRequest
Returns:
HTML content to insert into a dashboard zone

getDashboardData

public 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

Specified by:
getName in interface IDashboardComponent
Returns:
The Name

setName

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

Specified by:
setName in interface IDashboardComponent
Parameters:
strName - The Name

getRight

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

Specified by:
getRight in interface IDashboardComponent
Returns:
The Right

setRight

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

Specified by:
setRight in interface IDashboardComponent
Parameters:
strRight - The Right

getZone

public int getZone()
Returns the Zone

Specified by:
getZone in interface IDashboardComponent
Returns:
The Zone

setZone

public void setZone(int nZone)
Sets the Zone

Specified by:
setZone in interface IDashboardComponent
Parameters:
nZone - The Zone

getOrder

public int getOrder()
Returns the Order

Specified by:
getOrder in interface IDashboardComponent
Returns:
The Order

setOrder

public void setOrder(int nOrder)
Sets the Order

Specified by:
setOrder in interface IDashboardComponent
Parameters:
nOrder - The Order

getPlugin

public Plugin getPlugin()
Returns the Plugin

Specified by:
getPlugin in interface IDashboardComponent
Returns:
The Plugin

setPlugin

public void setPlugin(Plugin plugin)
Sets the Plugin

Specified by:
setPlugin in interface IDashboardComponent
Parameters:
plugin - The plugin

compareTo

public int compareTo(IDashboardComponent o)
Compare component order

Specified by:
compareTo in interface java.lang.Comparable<IDashboardComponent>
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

Specified by:
isEnabled in interface IDashboardComponent
Returns:
true if enabled

equals

public boolean equals(java.lang.Object obj)

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object


Copyright © 2011 Mairie de Paris. All Rights Reserved.