fr.paris.lutece.portal.service.dashboard.admin
Class AdminDashboardService

java.lang.Object
  extended by fr.paris.lutece.portal.service.dashboard.admin.AdminDashboardService

public class AdminDashboardService
extends java.lang.Object

AdminDashboardService


Method Summary
 void doMoveDashboard(IAdminDashboardComponent dashboard, int nOldColumn, int nOldOrder, boolean bCreate)
          Moves the dashboard.
 void doReorderColumn(int nColumn)
          Reorders column's dashboard
 java.util.List<IAdminDashboardComponent> getAdminDashboardComponents(int nColumn)
           
 java.util.List<IAdminDashboardComponent> getAllAdminDashboardComponents()
          All known dashboards as declared in SpringContext
 java.util.Map<java.lang.String,java.util.List<IAdminDashboardComponent>> getAllSetDashboards()
          Finds all dashboard with column and order set.
 int getColumnCount()
          Returns the column count, with PROPERTY_COLUMN_COUNT.
 java.lang.String getDashboardData(AdminUser user, int nColumn)
          Gets Data from all components of the zone
static AdminDashboardService getInstance()
          Return the unique instance
 java.util.List<IAdminDashboardComponent> getNotSetDashboards()
          Returns all dashboards with no column/order set
 java.util.Map<java.lang.String,java.lang.Boolean> getOrderedColumnsStatus()
          Builds the map to with column id as key, and true as value if column is well ordered, false otherwise.
 void registerDashboardComponent(DashboardComponentEntry entry, Plugin plugin)
          Register a Dashboard Component
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static AdminDashboardService getInstance()
Return the unique instance

Returns:
The instance

getColumnCount

public int getColumnCount()
Returns the column count, with PROPERTY_COLUMN_COUNT. Default is CONSTANTE_DEFAULT_COLUMN_COUNT

Returns:
the column count

getAllAdminDashboardComponents

public java.util.List<IAdminDashboardComponent> getAllAdminDashboardComponents()
All known dashboards as declared in SpringContext

Returns:
dashboards list

getAdminDashboardComponents

public java.util.List<IAdminDashboardComponent> getAdminDashboardComponents(int nColumn)
Parameters:
nColumn - the column id
Returns:
all dashboards for this column

registerDashboardComponent

public void registerDashboardComponent(DashboardComponentEntry entry,
                                       Plugin plugin)
Register a Dashboard Component

Parameters:
entry - The DashboardComponent entry defined in the plugin's XML file
plugin - The plugin

doMoveDashboard

public void doMoveDashboard(IAdminDashboardComponent dashboard,
                            int nOldColumn,
                            int nOldOrder,
                            boolean bCreate)
Moves the dashboard.

Parameters:
dashboard - to move, with new values
nOldColumn - previous column id
nOldOrder - previous order
bCreate - true if this is a new dashboard, false otherwise.

getNotSetDashboards

public java.util.List<IAdminDashboardComponent> getNotSetDashboards()
Returns all dashboards with no column/order set

Returns:
all dashboards with no column/order set

getAllSetDashboards

public java.util.Map<java.lang.String,java.util.List<IAdminDashboardComponent>> getAllSetDashboards()
Finds all dashboard with column and order set.

Returns:
a map where key is the column id, and value is the column's dashboard list.

getDashboardData

public java.lang.String getDashboardData(AdminUser user,
                                         int nColumn)
Gets Data from all components of the zone

Parameters:
user - The user
nColumn - The dasboard column
Returns:
Data of all components of the zone

doReorderColumn

public void doReorderColumn(int nColumn)
Reorders column's dashboard

Parameters:
nColumn - the column to reorder

getOrderedColumnsStatus

public java.util.Map<java.lang.String,java.lang.Boolean> getOrderedColumnsStatus()
Builds the map to with column id as key, and true as value if column is well ordered, false otherwise.

Returns:
the map


Copyright © 2010 Mairie de Paris. All Rights Reserved.