fr.paris.lutece.plugins.document.service.spaces
Class DocumentSpacesService

java.lang.Object
  extended by fr.paris.lutece.plugins.document.service.spaces.DocumentSpacesService

public class DocumentSpacesService
extends java.lang.Object

Document Spaces management Service.


Field Summary
static java.lang.String PARAMETER_BROWSER_SELECTED_SPACE_ID
           
 
Method Summary
static DocumentSpacesService getInstance()
          Returns the unique instance of the service
 java.lang.String getLabelSpacePath(int nIdDocumentSpace, fr.paris.lutece.portal.business.user.AdminUser user)
          the path of the document space
 java.lang.String getSpacesBrowser(javax.servlet.http.HttpServletRequest request, fr.paris.lutece.portal.business.user.AdminUser user, java.util.Locale locale, boolean bFilterViewRollUser, boolean bFilterWorkspaceUser)
          get the HTML code to display a space browser.
 javax.xml.transform.Source getTreeXsl()
          Gets the XSL to display user spaces tree
 java.util.List<DocumentSpace> getUserAllowedSpaces(fr.paris.lutece.portal.business.user.AdminUser user)
           
 int getUserDefaultSpace(fr.paris.lutece.portal.business.user.AdminUser user)
          Gets user default space
 java.lang.String getXmlSpacesList(fr.paris.lutece.portal.business.user.AdminUser user)
          Gets allowed Spaces for a given user as an XML document
 boolean isAuthorizedViewByRole(int nIdSpace, fr.paris.lutece.portal.business.user.AdminUser user)
          Check if the user can view a space according its role
 boolean isAuthorizedViewByWorkgroup(int nIdSpace, fr.paris.lutece.portal.business.user.AdminUser user)
          Check if a space should be visible to the user according its workgroup
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PARAMETER_BROWSER_SELECTED_SPACE_ID

public static final java.lang.String PARAMETER_BROWSER_SELECTED_SPACE_ID
See Also:
Constant Field Values
Method Detail

getInstance

public static DocumentSpacesService getInstance()
Returns the unique instance of the service

Returns:
the unique instance of the service

getXmlSpacesList

public java.lang.String getXmlSpacesList(fr.paris.lutece.portal.business.user.AdminUser user)
Gets allowed Spaces for a given user as an XML document

Parameters:
user - The current user
Returns:
An XML document containing allowed spaces

getUserDefaultSpace

public int getUserDefaultSpace(fr.paris.lutece.portal.business.user.AdminUser user)
Gets user default space

Parameters:
user - The current user
Returns:
The user default space

getTreeXsl

public javax.xml.transform.Source getTreeXsl()
Gets the XSL to display user spaces tree

Returns:
The XSL to display user spaces tree

isAuthorizedViewByRole

public boolean isAuthorizedViewByRole(int nIdSpace,
                                      fr.paris.lutece.portal.business.user.AdminUser user)
Check if the user can view a space according its role

Parameters:
nIdSpace - The Space Id
user - The current user
Returns:
True if the user has the permission to view document Space.

isAuthorizedViewByWorkgroup

public boolean isAuthorizedViewByWorkgroup(int nIdSpace,
                                           fr.paris.lutece.portal.business.user.AdminUser user)
Check if a space should be visible to the user according its workgroup

Parameters:
nIdPage - the id of the page to check
user - The current user
Returns:
true if authorized, otherwise false

getUserAllowedSpaces

public java.util.List<DocumentSpace> getUserAllowedSpaces(fr.paris.lutece.portal.business.user.AdminUser user)

getSpacesBrowser

public java.lang.String getSpacesBrowser(javax.servlet.http.HttpServletRequest request,
                                         fr.paris.lutece.portal.business.user.AdminUser user,
                                         java.util.Locale locale,
                                         boolean bFilterViewRollUser,
                                         boolean bFilterWorkspaceUser)
get the HTML code to display a space browser.

Parameters:
request - The HTTP request
user - The current user
bFilterViewRollUser - true if the list of childs space must be filter by RBAC view permission
bFilterWorkspaceUser - true if the list of childs space must be filter by workgroup
locale - The Locale
Returns:
The HTML form

getLabelSpacePath

public java.lang.String getLabelSpacePath(int nIdDocumentSpace,
                                          fr.paris.lutece.portal.business.user.AdminUser user)
the path of the document space

Parameters:
nIdDocumentSpace - the id of the document space
user - the user
Returns:
the path of the document space


Copyright © 2009 Mairie de Paris. All Rights Reserved.