All Superinterfaces:

BaseImageService<NewConfigurationImageParams>, Service

All Known Subinterfaces:

ConfigurationImageServiceLocal

All Known Implementing Classes:

ConfigurationImageServiceImpl, ConfigurationImageServiceSecurity
```
public interface ConfigurationImageService
extends BaseImageService<NewConfigurationImageParams>
```
Service interface for configuration images. The parameter for saving images is an object containing the configuration identifier and the image type.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ConfigurationImageVO`	`getImageVO(ConfigurationVO configuration, @NotNull ConfigurationImageType type)`	Returns data about a configuration image, for a given type.
`ConfigurationImagesListData`	`getListData(@NotNull ConfigurationVO configuration)`	Returns data to list images in a given configuration
`List<ConfigurationImageVO>`	`list(@NotNull ConfigurationVO configuration)`	Lists a configuration's images, optionally including inherited images from parent configurations
`ConfigurationImageVO`	`load(@NotNull Long id)`	Returns metadata of a configuration image by id
`void`	`removeByConfigurationAndType(@NotNull ConfigurationVO configuration, @NotNull 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
remove, removeAll, save, saveName

Method Detail

getImageVO

ConfigurationImageVO getImageVO(@Nullable
                                ConfigurationVO configuration,
                                @NotNull
                                @NotNull ConfigurationImageType type)
                         throws FrameworkException

Returns data about a configuration image, for a given type. If the configuration is null, assumes the current configuration.

Throws:: FrameworkException

getListData

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

Returns data to list images in a given configuration

Throws:: FrameworkException

list

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

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

Throws:: FrameworkException

load

ConfigurationImageVO load(@NotNull
                          @NotNull Long id)
                   throws FrameworkException

Returns metadata of a configuration image by id

Throws:: FrameworkException

removeByConfigurationAndType

void removeByConfigurationAndType(@NotNull
                                  @NotNull ConfigurationVO configuration,
                                  @NotNull
                                  @NotNull ConfigurationImageType type)
                           throws FrameworkException

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

Throws:: FrameworkException

Interface ConfigurationImageService