fr.paris.lutece.plugins.profiles.business.views
Class ViewHome

java.lang.Object
  extended by fr.paris.lutece.plugins.profiles.business.views.ViewHome

public final class ViewHome
extends Object

ProfileHome


Method Summary
static void addProfileForView(String strViewKey, String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Add a profile for a view
static boolean checkExistView(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Check if a view already exists or not
static View create(View view, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Creation of an instance of View
static 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
static List<View> findAll(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns a List of Views objects
static View findByPrimaryKey(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Returns an instance of a profile whose identifier is specified in parameter
static List<Integer> findColumns(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds all columns
static fr.paris.lutece.portal.service.dashboard.IDashboardComponent findDashboard(String strDashboardName, String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Load the dashboard
static 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
static 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
static int findMaxOrder(int nColumn, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds the max order for the column.
static int findMaxOrder(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Finds the max order for all columns.
static View findViewForProfile(String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the view from a profile
static List<View> findViewsByFilter(ViewFilter vFilter, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Find Views by filter
static List<Profile> getProfilesListForView(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of profiles associated to the view
static fr.paris.lutece.util.ReferenceList getViewsList(fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Get the list of Views
static boolean hasView(String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Check if the given profile has a view or not
static void remove(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove the View whose identifier is specified in parameter
static void removeDashboard(String strViewKey, String strDashboardName, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete a dashboard of a view
static void removeDashboards(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Delete all dashboards of a view
static void removeProfileFromView(String strViewKey, String strProfileKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove a view from a profile
static void removeProfiles(String strViewKey, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Remove a profile from a view
static View update(View view, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update of the view which is specified in parameter
static void updateDashboard(String strViewKey, fr.paris.lutece.portal.service.dashboard.IDashboardComponent dashboard, fr.paris.lutece.portal.service.plugin.Plugin plugin)
          Update a dashboard
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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.