Package org.cyclos.services.contentmanagement

Interface ThemeService

All Superinterfaces:

CRUDService<ThemeDTO,ThemeData,ThemeDataParams>, Service

All Known Subinterfaces:

ThemeServiceLocal

public interface ThemeService
extends CRUDService<ThemeDTO,ThemeData,ThemeDataParams>

Contains the operations over themes

Method Summary

Modifier and Type	Method	Description
void	applyThemes(@NotNull ApplyThemesDTO params)	Applies the given themes to the given configuration: logged user, guests, mobile and pay application.
FileInfo	export(@NotNull Long id)	Exports the given theme
String	getCSS(@NotNull Long id)	Returns the CSS corresponding to the theme with the given id
String	getFallbackCSS(@NotNull ThemeType type)	Returns a default CSS corresponding to the theme type.
ThemesListData	getListData(@NotNull ConfigurationVO configuration)	Returns data to list themes in a configuration
ThemeVO	getTheme(ThemeType type)	Returns the theme for the given type.
ThemeVO	getVO(@NotNull Long id)	Returns the ThemeVO with the given id.
Long	importNew(@NotNull ConfigurationVO configuration, String importedFromFile, SerializableInputStream in)	Import the theme definitions from file, creating it on the given configuration, returning the new theme id
List<ThemeVO>	list(@NotNull ConfigurationVO configuration)	Returns a list with visible themes on the given configuration sorted by theme type (first main web themes)

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

applyThemes

void applyThemes(@NotNull
                 @NotNull ApplyThemesDTO params)
          throws FrameworkException

Applies the given themes to the given configuration: logged user, guests, mobile and pay application. Passing null means the theme will be inherited from parent configurations, but is not possible for the system default configuration. The themes must be defined within that configuration or in any of it's ancestors.

Throws:

FrameworkException

export

FileInfo export(@NotNull
                @NotNull Long id)
         throws FrameworkException

Exports the given theme

Throws:

FrameworkException

getCSS

String getCSS(@NotNull
              @NotNull Long id)
       throws FrameworkException

Returns the CSS corresponding to the theme with the given id

Throws:

FrameworkException

getFallbackCSS

String getFallbackCSS(@NotNull
                      @NotNull ThemeType type)
               throws FrameworkException

Returns a default CSS corresponding to the theme type. It's used only in case the selected theme fails to compile.

Throws:

FrameworkException

getListData

ThemesListData getListData(@NotNull
                           @NotNull ConfigurationVO configuration)
                    throws FrameworkException

Returns data to list themes in a configuration

Throws:

FrameworkException

getTheme

ThemeVO getTheme(ThemeType type)
          throws FrameworkException

Returns the theme for the given type. In case of ThemeType.MAIN_WEB the returned theme depends on if there is a logged user or not.

Throws:

FrameworkException

getVO

ThemeVO getVO(@NotNull
              @NotNull Long id)
       throws FrameworkException

Returns the ThemeVO with the given id.

Throws:

FrameworkException

importNew

Long importNew(@NotNull
               @NotNull ConfigurationVO configuration,
               String importedFromFile,
               SerializableInputStream in)
        throws FrameworkException,
               FileParsingException

Import the theme definitions from file, creating it on the given configuration, returning the new theme id

Throws:

FrameworkException

FileParsingException

list

List<ThemeVO> list(@NotNull
                   @NotNull ConfigurationVO configuration)
            throws FrameworkException

Returns a list with visible themes on the given configuration sorted by theme type (first main web themes)

Throws:

FrameworkException