fr.paris.lutece.plugins.profiles.service.views
Interface IViewsService

All Known Implementing Classes:
ViewsService

public interface IViewsService

IViewsService


Method Summary
 void addProfileForView(String strViewKey, String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Add a profile for a view
 boolean checkExistView(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Check if a view already exists or not
 View create(View view, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Creation of an instance of View
 void createDashboard(String strViewKey, fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Insert a dashboard for a view
 void doMoveDashboard(fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard, int nOldColumn, int nOldOrder, boolean bCreate, String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Moves the dashboard.
 void doReorderColumn(String strViewKey, int nColumn, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Reorders column's dashboard
 List<View> findAll(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns a List of Views objects
 View findByPrimaryKey(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns an instance of a profile whose identifier is specified in parameter
 List<Integer> findColumns(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds all columns
 fr.paris.lutece.portal.service.dashboard.IDashboardComponent findDashboard(String strDashboardName, String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the dashboard
 List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> findDashboards(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the list of dashboards from a given view key
 List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> findDashboardsByFilter(fr.paris.lutece.portal.business.dashboard.DashboardFilter filter, String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Loads the data of all the IDashboardComponent
 int findMaxOrder(int nColumn, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds the max order for the column.
 int findMaxOrder(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds the max order for all columns.
 View findViewForProfile(String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the view from a profile
 List<View> findViewsByFilter(ViewFilter vFilter, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Find Views by filter
 Map<String,List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent>> getAllSetDashboards(String strViewKey, fr.paris.lutece.portal.business.user.AdminUser user, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of dashboards of the given view
 List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> getDashboardComponents(String strViewKey, int nColumn, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the dashboard component
 fr.paris.lutece.util.html.ItemNavigator getItemNavigator(ViewFilter vFilter, View view, fr.paris.lutece.util.url.UrlItem url)
          Get the item navigator
 List<ViewAction> getListActions(fr.paris.lutece.portal.business.user.AdminUser user, View view, String strPermission, Locale locale, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of actions
 fr.paris.lutece.util.ReferenceList getListAvailableColumns()
          Returns list with available column
 fr.paris.lutece.util.ReferenceList getListAvailableOrders(int nColumn, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Orders reference list for the given column
 Map<String,fr.paris.lutece.util.ReferenceList> getMapAvailableOrders(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Builds all refList order for all columns
 List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> getNotSetDashboards(String strViewKey, fr.paris.lutece.portal.business.user.AdminUser user, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of dashboards that are not set
 Map<String,Boolean> getOrderedColumnsStatus(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Builds the map to with column id as key, and true as value if column is well ordered, false otherwise.
 List<Profile> getProfilesListForView(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of profiles associated to the view
 fr.paris.lutece.util.ReferenceList getViewsList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of Views
 boolean hasView(String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Check if the given profile has a view or not
 void remove(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove the View whose identifier is specified in parameter
 void removeDashboard(String strViewKey, String strDashboardName, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete a dashboard of a view
 void removeDashboards(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete all dashboards of a view
 void removeProfileFromView(String strViewKey, String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove a view from a profile
 void removeProfiles(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove a profile from a view
 View update(View view, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update of the view which is specified in parameter
 void updateDashboard(String strViewKey, fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update a dashboard
 

Method Detail

getItemNavigator

fr.paris.lutece.util.html.ItemNavigator getItemNavigator(ViewFilter vFilter,
                                                         View view,
                                                         fr.paris.lutece.util.url.UrlItem url)
Get the item navigator

Parameters:
vFilter - the view filter
view - the view
url - the url
Returns:
the item navigator

getListActions

List<ViewAction> getListActions(fr.paris.lutece.portal.business.user.AdminUser user,
                                View view,
                                String strPermission,
                                Locale locale,
                                fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the list of actions

Parameters:
user - the current user
view - the view
strPermission - the permission name
locale - Locale
plugin - Plugin
Returns:
the list of actions

getAllSetDashboards

Map<String,List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent>> getAllSetDashboards(String strViewKey,
                                                                                                   fr.paris.lutece.portal.business.user.AdminUser user,
                                                                                                   fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the list of dashboards of the given view

Parameters:
strViewKey - the view key
user - the current user
plugin - Plugin
Returns:
the list of dashboards

getNotSetDashboards

List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> getNotSetDashboards(String strViewKey,
                                                                                       fr.paris.lutece.portal.business.user.AdminUser user,
                                                                                       fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the list of dashboards that are not set

Parameters:
strViewKey - the view key
user - the admin user
plugin - Plugin
Returns:
the list of dashboards

getMapAvailableOrders

Map<String,fr.paris.lutece.util.ReferenceList> getMapAvailableOrders(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Builds all refList order for all columns

Parameters:
plugin - Plugin
Returns:
the map with column id as key

getListAvailableOrders

fr.paris.lutece.util.ReferenceList getListAvailableOrders(int nColumn,
                                                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Orders reference list for the given column

Parameters:
nColumn - column
plugin - Plugin
Returns:
the refList

getListAvailableColumns

fr.paris.lutece.util.ReferenceList getListAvailableColumns()
Returns list with available column

Returns:
all available columns

doMoveDashboard

void doMoveDashboard(fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard,
                     int nOldColumn,
                     int nOldOrder,
                     boolean bCreate,
                     String strViewKey,
                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
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.
strViewKey - the view key
plugin - the plugin

getDashboardComponents

List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> getDashboardComponents(String strViewKey,
                                                                                          int nColumn,
                                                                                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the dashboard component

Parameters:
strViewKey - the view key
nColumn - the column id
plugin - the plugins
Returns:
all dashboards for this column

doReorderColumn

void doReorderColumn(String strViewKey,
                     int nColumn,
                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Reorders column's dashboard

Parameters:
strViewKey - the view key
nColumn - the column to reorder
plugin - the plugin

getOrderedColumnsStatus

Map<String,Boolean> getOrderedColumnsStatus(String strViewKey,
                                            fr.paris.lutece.portal.service.plugin.Plugin plugin)
Builds the map to with column id as key, and true as value if column is well ordered, false otherwise.

Parameters:
strViewKey - the view key
plugin - the plugin
Returns:
the map

create

View create(View view,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)
Creation of an instance of View

Parameters:
view - The instance of the View which contains the informations to store
plugin - Plugin
Returns:
The instance of View which has been created with its primary key.

update

View update(View view,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)
Update of the view which is specified in parameter

Parameters:
view - The instance of the view which contains the new data to store
plugin - Plugin
Returns:
The instance of the view which has been updated

remove

void remove(String strViewKey,
            fr.paris.lutece.portal.service.plugin.Plugin plugin)
Remove the View whose identifier is specified in parameter

Parameters:
strViewKey - The View object to remove
plugin - Plugin

findByPrimaryKey

View findByPrimaryKey(String strViewKey,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns an instance of a profile whose identifier is specified in parameter

Parameters:
strViewKey - The key of the View
plugin - Plugin
Returns:
An instance of View

findAll

List<View> findAll(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Returns a List of Views objects

Parameters:
plugin - Plugin
Returns:
A List of Views

findViewsByFilter

List<View> findViewsByFilter(ViewFilter vFilter,
                             fr.paris.lutece.portal.service.plugin.Plugin plugin)
Find Views by filter

Parameters:
vFilter - the Filter
plugin - Plugin
Returns:
List of Views

checkExistView

boolean checkExistView(String strViewKey,
                       fr.paris.lutece.portal.service.plugin.Plugin plugin)
Check if a view already exists or not

Parameters:
strViewKey - The view key
plugin - Plugin
Returns:
true if it already exists, false otherwise

getViewsList

fr.paris.lutece.util.ReferenceList getViewsList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the list of Views

Parameters:
plugin - Plugin
Returns:
the list of Views

getProfilesListForView

List<Profile> getProfilesListForView(String strViewKey,
                                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the list of profiles associated to the view

Parameters:
strViewKey - The view Key
plugin - Plugin
Returns:
The list of profile

findViewForProfile

View findViewForProfile(String strProfileKey,
                        fr.paris.lutece.portal.service.plugin.Plugin plugin)
Get the view from a profile

Parameters:
strProfileKey - the profile key
plugin - Plugin
Returns:
the view associated to the profile

hasView

boolean hasView(String strProfileKey,
                fr.paris.lutece.portal.service.plugin.Plugin plugin)
Check if the given profile has a view or not

Parameters:
strProfileKey - the profile key
plugin - Plugin
Returns:
true if the profile has the view, false otherwise

addProfileForView

void addProfileForView(String strViewKey,
                       String strProfileKey,
                       fr.paris.lutece.portal.service.plugin.Plugin plugin)
Add a profile for a view

Parameters:
strViewKey - The view Key
strProfileKey - The profile Key
plugin - Plugin

removeProfiles

void removeProfiles(String strViewKey,
                    fr.paris.lutece.portal.service.plugin.Plugin plugin)
Remove a profile from a view

Parameters:
strViewKey - The view Key
plugin - Plugin

removeProfileFromView

void removeProfileFromView(String strViewKey,
                           String strProfileKey,
                           fr.paris.lutece.portal.service.plugin.Plugin plugin)
Remove a view from a profile

Parameters:
strViewKey - the view key
strProfileKey - the profile key
plugin - Plugin

findDashboards

List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> findDashboards(String strViewKey,
                                                                                  fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the list of dashboards from a given view key

Parameters:
strViewKey - the view key
plugin - Plugin
Returns:
a list of IDashboardComponent

findDashboard

fr.paris.lutece.portal.service.dashboard.IDashboardComponent findDashboard(String strDashboardName,
                                                                           String strViewKey,
                                                                           fr.paris.lutece.portal.service.plugin.Plugin plugin)
Load the dashboard

Parameters:
strDashboardName - the dashboard name
strViewKey - the view key
plugin - Plugin
Returns:
the dashboard

createDashboard

void createDashboard(String strViewKey,
                     fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard,
                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Insert a dashboard for a view

Parameters:
strViewKey - the view key
dashboard - the dashboard
plugin - Plugin

removeDashboards

void removeDashboards(String strViewKey,
                      fr.paris.lutece.portal.service.plugin.Plugin plugin)
Delete all dashboards of a view

Parameters:
strViewKey - the view key
plugin - Plugin

removeDashboard

void removeDashboard(String strViewKey,
                     String strDashboardName,
                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Delete a dashboard of a view

Parameters:
strViewKey - the view key
strDashboardName - the dashboard name
plugin - Plugin

updateDashboard

void updateDashboard(String strViewKey,
                     fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard,
                     fr.paris.lutece.portal.service.plugin.Plugin plugin)
Update a dashboard

Parameters:
strViewKey - the view key
dashboard - the dashboard
plugin - Plugin

findDashboardsByFilter

List<fr.paris.lutece.portal.service.dashboard.IDashboardComponent> findDashboardsByFilter(fr.paris.lutece.portal.business.dashboard.DashboardFilter filter,
                                                                                          String strViewKey,
                                                                                          fr.paris.lutece.portal.service.plugin.Plugin plugin)
Loads the data of all the IDashboardComponent

Parameters:
filter - the filter
strViewKey - the view key
plugin - Plugin
Returns:
the list which contains the data of all the IDashboardComponent

findMaxOrder

int findMaxOrder(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Finds the max order for all columns.

Parameters:
plugin - Plugin
Returns:
the max order

findMaxOrder

int findMaxOrder(int nColumn,
                 fr.paris.lutece.portal.service.plugin.Plugin plugin)
Finds the max order for the column.

Parameters:
nColumn - the column
plugin - Plugin
Returns:
the max order

findColumns

List<Integer> findColumns(fr.paris.lutece.portal.service.plugin.Plugin plugin)
Finds all columns

Parameters:
plugin - Plugin
Returns:
the list of columns


Copyright © 2013 Mairie de Paris. All Rights Reserved.