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

Class AdminDashboardService

java.lang.Object

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

public final class AdminDashboardService
extends Object

AdminDashboardService

Method Summary

Modifier and Type	Method and Description
void	doMoveDashboard(IAdminDashboardComponent dashboard, int nOldColumn, int nOldOrder, boolean bCreate) Moves the dashboard.
void	doReorderColumn(int nColumn) Reorders column's dashboard
List<IAdminDashboardComponent>	getAdminDashboardComponents(int nColumn)
List<IAdminDashboardComponent>	getAllAdminDashboardComponents() All known dashboards as declared in SpringContext
Map<String,List<IAdminDashboardComponent>>	getAllSetDashboards() Finds all dashboard with column and order set.
int	getColumnCount() Returns the column count, with PROPERTY_COLUMN_COUNT.
String	getDashboardData(AdminUser user, int nColumn, javax.servlet.http.HttpServletRequest request) Gets Data from all components of the zone
static AdminDashboardService	getInstance() Return the unique instance
List<IAdminDashboardComponent>	getNotSetDashboards() Returns all dashboards with no column/order set
Map<String,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

equals, 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 List<IAdminDashboardComponent> getAllAdminDashboardComponents()

All known dashboards as declared in SpringContext

Returns:

dashboards list

getAdminDashboardComponents

public 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 List<IAdminDashboardComponent> getNotSetDashboards()

Returns all dashboards with no column/order set

Returns:

all dashboards with no column/order set

getAllSetDashboards

public Map<String,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 String getDashboardData(AdminUser user,
                               int nColumn,
                               javax.servlet.http.HttpServletRequest request)

Gets Data from all components of the zone

Parameters:

user - The user

nColumn - The dasboard column

request - HttpServletRequest

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 Map<String,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