fr.paris.lutece.portal.service.portal
Interface IThemeService


public interface IThemeService

IThemeService


Method Summary
 Theme create(Theme theme)
          Creation of an instance of a theme
 Theme getGlobalTheme()
          Get the global theme
 Theme getTheme(java.lang.String strTheme)
          Get the theme given the code_theme
 ReferenceList getThemes()
          Get all themes
 java.util.Collection<Theme> getThemesList()
          Return the list of all the themes
 java.lang.String getUserTheme(javax.servlet.http.HttpServletRequest request)
          Gets the theme selected by the user
 boolean isValidTheme(java.lang.String strCodeTheme)
          Checks if the theme is among existing themes
 void remove(java.lang.String strCodeTheme)
          Remove the theme whose identifier is specified in parameter
 void setGlobalTheme(java.lang.String strGlobalTheme)
          Set the global theme
 Theme update(Theme theme)
          Update of the theme which is specified
 

Method Detail

getGlobalTheme

Theme getGlobalTheme()
Get the global theme

Returns:
the default theme

setGlobalTheme

void setGlobalTheme(java.lang.String strGlobalTheme)
Set the global theme

Parameters:
strGlobalTheme - the global theme

getTheme

Theme getTheme(java.lang.String strTheme)
Get the theme given the code_theme

Parameters:
strTheme - the code_theme
Returns:
the theme

getThemes

ReferenceList getThemes()
Get all themes

Returns:
a list of Theme

getUserTheme

java.lang.String getUserTheme(javax.servlet.http.HttpServletRequest request)
Gets the theme selected by the user

Parameters:
request - The HTTP request
Returns:
The theme if available otherwise null

create

Theme create(Theme theme)
Creation of an instance of a theme

Parameters:
theme - An instance of a theme which contains the informations to store
Returns:
The instance of a theme which has been created with its primary key.

update

Theme update(Theme theme)
Update of the theme which is specified

Parameters:
theme - The instance of the theme which contains the data to store
Returns:
The instance of the theme which has been updated

remove

void remove(java.lang.String strCodeTheme)
Remove the theme whose identifier is specified in parameter

Parameters:
strCodeTheme - The identifier of the theme to remove

getThemesList

java.util.Collection<Theme> getThemesList()
Return the list of all the themes

Returns:
A collection of themes objects

isValidTheme

boolean isValidTheme(java.lang.String strCodeTheme)
Checks if the theme is among existing themes

Parameters:
strCodeTheme - The theme to check
Returns:
True if the theme is valid


Copyright © 2012 Mairie de Paris. All Rights Reserved.