org.cyclos.services.contentmanagement

Interface ThemeImageService

All Superinterfaces:

BaseImageService<ThemeImageVO,NewThemeImageParams>, Service

All Known Subinterfaces:

ThemeImageServiceLocal

public interface ThemeImageService
extends BaseImageService<ThemeImageVO,NewThemeImageParams>

Service for manipulating theme images. The parameter for saving images is an object containing the theme identifier and the image type.

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
ThemeImageVO	getImageVO(java.lang.Long themeId, ThemeImageType type, java.lang.String name) Returns the image VO for the image with the given data, or throws an EntityNotFoundException if the given image doesn't exist
java.util.List<ThemeImageVO>	list(java.lang.Long themeId, java.util.Set<ThemeImageType> types) Lists the given theme's images of the given types
SerializableInputStream	readImageContent(java.lang.Long themeId, ThemeImageType type, java.lang.String name, java.util.List<java.lang.String> colors) Returns the content of an image, according to the given image nature

Methods inherited from interface org.cyclos.services.system.BaseImageService

load, loadByKey, readContent, readContentByKey, remove, save, saveName

Method Detail

getImageVO

ThemeImageVO getImageVO(java.lang.Long themeId,
                      ThemeImageType type,
                      java.lang.String name)
                        throws FrameworkException

Returns the image VO for the image with the given data, or throws an EntityNotFoundException if the given image doesn't exist

Throws:

FrameworkException

list

java.util.List<ThemeImageVO> list(java.lang.Long themeId,
                                java.util.Set<ThemeImageType> types)
                                  throws FrameworkException

Lists the given theme's images of the given types

Throws:

FrameworkException

readImageContent

SerializableInputStream readImageContent(java.lang.Long themeId,
                                       ThemeImageType type,
                                       java.lang.String name,
                                       java.util.List<java.lang.String> colors)
                                         throws FrameworkException

Returns the content of an image, according to the given image nature

Parameters:

themeId - The theme identifier

type - The image type. Will determine the semantics for the other parameters

name - Depends on the nature. When nature == ThemeImageType.CUSTOM, will be the file name. Otherwise, will be the name for the corresponding enumeration

colors - Only used when nature == ThemeImageType.STYLE_ICON, to colorize the SVGs with the given colors. When no colors are passed, uses the default colors from the theme

Throws:

FrameworkException

See Also:

ThemeImageType.getEnumItem(String)