|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfr.paris.lutece.portal.service.dashboard.DashboardService
public final class DashboardService
Dashboard Service
Method Summary | |
---|---|
void |
doMoveDashboard(IDashboardComponent dashboard,
int nOldColumn,
int nOldOrder,
boolean bCreate)
Moves the dashboard. |
void |
doReorderColumn(int nColumn)
Reorders column's dashboard |
java.util.List<IDashboardComponent> |
getAllDashboardComponents()
All known dashboards as declared in SpringContext |
java.util.Map<java.lang.String,java.util.List<IDashboardComponent>> |
getAllSetDashboards(AdminUser user)
Finds all dashboard with column and order set. |
int |
getColumnCount()
Returns the column count, with PROPERTY_COLUMN_COUNT . |
java.util.List<IDashboardComponent> |
getDashboardComponents(int nColumn)
|
java.lang.String |
getDashboardData(AdminUser user,
int nZone,
javax.servlet.http.HttpServletRequest request)
Gets Data from all components of the zone |
java.lang.String |
getDashboardData(java.util.List<IDashboardComponent> listDashboards,
AdminUser user,
int nZone,
javax.servlet.http.HttpServletRequest request)
Gets Data from all components of the zone |
java.util.List<IDashboardComponent> |
getDashboards(AdminUser user,
javax.servlet.http.HttpServletRequest request)
Get the list of dashboard from plugins |
static DashboardService |
getInstance()
Return the unique instance |
ReferenceList |
getListAvailableColumns()
Returns list with available column |
ReferenceList |
getListAvailableOrders(int nColumn)
Orders reference list for the given column |
java.util.Map<java.lang.String,ReferenceList> |
getMapAvailableOrders()
Builds all refList order for all columns |
java.util.List<IDashboardComponent> |
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 |
---|
public static DashboardService getInstance()
public int getColumnCount()
PROPERTY_COLUMN_COUNT
. Default is CONSTANTE_DEFAULT_COLUMN_COUNT
public java.util.List<IDashboardComponent> getAllDashboardComponents()
public java.util.List<IDashboardComponent> getDashboardComponents(int nColumn)
nColumn
- the column id
public void registerDashboardComponent(DashboardComponentEntry entry, Plugin plugin)
entry
- The DashboardComponent entry defined in the plugin's XML fileplugin
- The pluginpublic void doMoveDashboard(IDashboardComponent dashboard, int nOldColumn, int nOldOrder, boolean bCreate)
dashboard
- to move, with new valuesnOldColumn
- previous column idnOldOrder
- previous orderbCreate
- true
if this is a new dashboard, false
otherwise.public java.util.List<IDashboardComponent> getNotSetDashboards()
public java.util.Map<java.lang.String,java.util.List<IDashboardComponent>> getAllSetDashboards(AdminUser user)
user
- the current user
public java.lang.String getDashboardData(AdminUser user, int nZone, javax.servlet.http.HttpServletRequest request)
user
- The usernZone
- The dasboard zonerequest
- HttpServletRequest
public java.util.List<IDashboardComponent> getDashboards(AdminUser user, javax.servlet.http.HttpServletRequest request)
user
- the current userrequest
- HttpServletRequest
public java.lang.String getDashboardData(java.util.List<IDashboardComponent> listDashboards, AdminUser user, int nZone, javax.servlet.http.HttpServletRequest request)
listDashboards
- the list of dashboardsuser
- The usernZone
- The dasboard zonerequest
- HttpServletRequest
public void doReorderColumn(int nColumn)
nColumn
- the column to reorderpublic java.util.Map<java.lang.String,java.lang.Boolean> getOrderedColumnsStatus()
true
as value if column is well ordered, false
otherwise.
public ReferenceList getListAvailableColumns()
public java.util.Map<java.lang.String,ReferenceList> getMapAvailableOrders()
public ReferenceList getListAvailableOrders(int nColumn)
nColumn
- column
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |