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.portal;
35
36 import fr.paris.lutece.portal.business.style.Theme;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40
41 import javax.servlet.http.HttpServletRequest;
42
43
44 /**
45 *
46 * IThemeService
47 *
48 */
49 public interface IThemeService
50 {
51 /**
52 * Get the global theme
53 * @return the default theme
54 */
55 Theme getGlobalTheme( );
56
57 /**
58 * Set the global theme
59 * @param strGlobalTheme the global theme
60 */
61 void setGlobalTheme( String strGlobalTheme );
62
63 /**
64 * Get the theme given the <code>code_theme</code>
65 * @param strTheme the <code>code_theme</code>
66 * @return the theme
67 */
68 Theme getTheme( String strTheme );
69
70 /**
71 * Get all themes
72 * @return a list of Theme
73 */
74 ReferenceList getThemes( );
75
76 /**
77 * Gets the theme selected by the user
78 *
79 * @param request The HTTP request
80 * @return The theme if available otherwise null
81 */
82 String getUserTheme( HttpServletRequest request );
83
84 /**
85 * Creation of an instance of a theme
86 *
87 * @param theme An instance of a theme which contains the informations to store
88 * @return The instance of a theme which has been created with its primary key.
89 */
90 Theme create( Theme theme );
91
92 /**
93 * Update of the theme which is specified
94 *
95 * @param theme The instance of the theme which contains the data to store
96 * @return The instance of the theme which has been updated
97 */
98 Theme update( Theme theme );
99
100 /**
101 * Remove the theme whose identifier is specified in parameter
102 *
103 * @param strCodeTheme The identifier of the theme to remove
104 */
105 void remove( String strCodeTheme );
106
107 /**
108 * Return the list of all the themes
109 *
110 * @return A collection of themes objects
111 */
112 Collection<Theme> getThemesList( );
113
114 /**
115 * Checks if the theme is among existing themes
116 *
117 * @param strCodeTheme The theme to check
118 * @return True if the theme is valid
119 */
120 boolean isValidTheme( String strCodeTheme );
121 }