org.cyclos.services.system

Interface ConfigurationImageService

All Superinterfaces:

BaseImageService<ConfigurationImageVO,NewConfigurationImageParams>, Service

All Known Subinterfaces:

ConfigurationImageServiceLocal

public interface ConfigurationImageService
extends BaseImageService<ConfigurationImageVO,NewConfigurationImageParams>

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

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationImageVO	getImageVO(java.lang.Long configurationId, ConfigurationImageType type) Returns data about a configuration image, optionally searching inherited images from parent configurations.
ConfigurationImagesListData	getListData(java.lang.Long configurationId) Returns data to list images in a given configuration
java.util.List<ConfigurationImageVO>	list(java.lang.Long configurationId) Lists a configuration's images, optionally including inherited images from parent configurations
SerializableInputStream	readByConfigurationAndType(java.lang.Long configurationId, ConfigurationImageType type) Returns the content of a given configuration image, for the given configuration
void	removeByConfigurationAndType(java.lang.Long configurationId, ConfigurationImageType type) Removes a configuration image, making it inherit the default (either from a parent configuration or the hardcoded default)

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

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

Method Detail

getImageVO

ConfigurationImageVO getImageVO(java.lang.Long configurationId,
                              ConfigurationImageType type)
                                throws FrameworkException

Returns data about a configuration image, optionally searching inherited images from parent configurations. Passing null as configurationId will get the image from the logged user's configuration.

Throws:

FrameworkException

getListData

ConfigurationImagesListData getListData(java.lang.Long configurationId)
                                        throws FrameworkException

Returns data to list images in a given configuration

Throws:

FrameworkException

list

java.util.List<ConfigurationImageVO> list(java.lang.Long configurationId)
                                          throws FrameworkException

Lists a configuration's images, optionally including inherited images from parent configurations

Throws:

FrameworkException

readByConfigurationAndType

SerializableInputStream readByConfigurationAndType(java.lang.Long configurationId,
                                                 ConfigurationImageType type)
                                                   throws FrameworkException

Returns the content of a given configuration image, for the given configuration

Throws:

FrameworkException

removeByConfigurationAndType

void removeByConfigurationAndType(java.lang.Long configurationId,
                                ConfigurationImageType type)
                                  throws FrameworkException

Removes a configuration image, making it inherit the default (either from a parent configuration or the hardcoded default)

Throws:

FrameworkException