fr.paris.lutece.portal.service.page
Interface IPageService

All Known Implementing Classes:
PageService

public interface IPageService

Page Service Interface


Method Summary
 void createPage(Page page)
          Create a page
 String getPage(javax.servlet.http.HttpServletRequest request, int nMode)
          Returns the page for a given ID.
 String getPage(String strIdPage, int nMode, javax.servlet.http.HttpServletRequest request)
          Returns the page for a given ID.
 String getPageContent(int nIdPage, int nMode, javax.servlet.http.HttpServletRequest request)
          Build the page content.
 String getResourceTypeId()
          Return the ressource id type
 void invalidateContent(int nPageId)
          Invalidate Page Content
 boolean isAuthorizedAdminPage(int nId, String strPermission, AdminUser user)
          Check if authorized
 void removePage(int nPageId)
          Remove the page
 void updatePage(Page page)
          Update the page
 

Method Detail

getPageContent

String getPageContent(int nIdPage,
                      int nMode,
                      javax.servlet.http.HttpServletRequest request)
                      throws SiteMessageException
Build the page content.

Parameters:
nIdPage - The page ID
nMode - The current mode.
request - The HttpRequest
Returns:
The HTML code of the page as a String.
Throws:
SiteMessageException - occurs when a site message need to be displayed

getPage

String getPage(String strIdPage,
               int nMode,
               javax.servlet.http.HttpServletRequest request)
               throws SiteMessageException
Returns the page for a given ID. The page is built using XML data of each portlet or retrieved from the cache if it's enable.

Parameters:
strIdPage - The page ID
nMode - The current mode.
request - The HttpRequest
Returns:
The HTML code of the page as a String.
Throws:
SiteMessageException - occurs when a site message need to be displayed

getPage

String getPage(javax.servlet.http.HttpServletRequest request,
               int nMode)
               throws SiteMessageException
Returns the page for a given ID. The page is built using XML data of each portlet or retrieved from the cache if it's enable.

Parameters:
request - The page ID
nMode - The current mode.
Returns:
The HTML code of the page as a String.
Throws:
SiteMessageException - If a message shouldbe displayed

invalidateContent

void invalidateContent(int nPageId)
Invalidate Page Content

Parameters:
nPageId - The Page ID

updatePage

void updatePage(Page page)
Update the page

Parameters:
page - The page

removePage

void removePage(int nPageId)
Remove the page

Parameters:
nPageId - The page's id

createPage

void createPage(Page page)
Create a page

Parameters:
page - The page to create

isAuthorizedAdminPage

boolean isAuthorizedAdminPage(int nId,
                              String strPermission,
                              AdminUser user)
Check if authorized

Parameters:
nId - The Page's ID
strPermission - The given permission
user - The user
Returns:
True if authorized, otherwise false

getResourceTypeId

String getResourceTypeId()
Return the ressource id type

Returns:
the resource type id


Copyright © 2014 Mairie de Paris. All Rights Reserved.