1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.portal.service.page;
35
36 import fr.paris.lutece.portal.business.page.Page;
37 import fr.paris.lutece.portal.business.user.AdminUser;
38 import fr.paris.lutece.portal.service.message.SiteMessageException;
39
40 import javax.servlet.http.HttpServletRequest;
41
42
43 /**
44 * Page Service Interface
45 */
46 public interface IPageService
47 {
48 /**
49 * Build the page content.
50 *
51 * @param nIdPage The page ID
52 * @param nMode The current mode.
53 * @param request The HttpRequest
54 * @return The HTML code of the page as a String.
55 * @throws SiteMessageException occurs when a site message need to be displayed
56 */
57 String getPageContent( int nIdPage, int nMode, HttpServletRequest request )
58 throws SiteMessageException;
59
60 /**
61 * Returns the page for a given ID. The page is built using XML data of each
62 * portlet or retrieved from the cache if it's enable.
63 *
64 * @param strIdPage The page ID
65 * @param nMode The current mode.
66 * @param request The HttpRequest
67 * @return The HTML code of the page as a String.
68 * @throws SiteMessageException occurs when a site message need to be displayed
69 */
70 String getPage( String strIdPage, int nMode, HttpServletRequest request )
71 throws SiteMessageException;
72
73 /**
74 * Returns the page for a given ID. The page is built using XML data of each
75 * portlet or retrieved from the cache if it's enable.
76 *
77 * @param request The page ID
78 * @param nMode The current mode.
79 * @return The HTML code of the page as a String.
80 * @throws SiteMessageException If a message shouldbe displayed
81 */
82 String getPage( HttpServletRequest request, int nMode )
83 throws SiteMessageException;
84
85 /**
86 * Invalidate Page Content
87 * @param nPageId The Page ID
88 */
89 void invalidateContent( int nPageId );
90
91 /**
92 * Update the page
93 * @param page The page
94 */
95 void updatePage( Page page );
96
97 /**
98 * Remove the page
99 * @param nPageId The page's id
100 */
101 void removePage( int nPageId );
102
103 /**
104 * Create a page
105 * @param page The page to create
106 */
107 void createPage( Page page );
108
109 /**
110 * Check if authorized
111 * @param nId The Page's ID
112 * @param strPermission The given permission
113 * @param user The user
114 * @return True if authorized, otherwise false
115 */
116 boolean isAuthorizedAdminPage( int nId, String strPermission, AdminUser user );
117
118 /**
119 * Return the ressource id type
120 * @return the resource type id
121 */
122 String getResourceTypeId( );
123 }