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