org.cyclos.impl.system

Interface ConfigurationServiceLocal

All Superinterfaces:

ConfigurationService, CRUDService<ConfigurationDTO,ConfigurationData,java.lang.Long>, org.cyclos.impl.CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,java.lang.Long>, Service

public interface ConfigurationServiceLocal
extends ConfigurationService, org.cyclos.impl.CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,java.lang.Long>

Local interface for configuration

Author:

luis

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAccessorCache() It schedules a clear to the accessor cache.
Configuration	createDefaultForNetwork(Network network) Creates the default configuration for the given network
java.util.List<Configuration>	getConfigurationTreePath(Configuration configuration) Returns the configuration tree path for the given configuration If the logged user is global then the global configurations will also be returned.
boolean	isPasswordTypeInUse(PasswordType passwordType) Returns whether the given password type is used as access password or confirmation password by any channel configuration
java.util.List<Configuration>	listAll() Returns all configurations
java.util.List<Configuration>	listByThemeUsage(Theme theme, ThemeUsage usage) Lists the configurations which uses the given theme under the given usage type
java.util.List<Configuration>	listVisible() Returns the configurations which are visible by the logged administrator
void	removeGroup(Group group) Removes a group from any configuration; usually done when the group is disabled, and not supposed to show up anymore.
<T> void	setConfiguration(Configuration configuration, com.mysema.query.types.Path<T> path, T value) Sets a configuration property and add it on the defined collection
void	setLocalization(Configuration configuration, Language language, java.lang.String country, java.lang.String timeZoneId) Sets the localization options in the given configuration, defining the language, country and time zone, as well as fields derived from the language and coutry, like date and number format.
java.util.List<Configuration>	sortByHierarchy(java.util.Collection<Configuration> configurations) Sort the given configurations according to the hierarchy
<T extends ActiveConfigurationData> T	toActiveConfiguration(java.lang.Class<T> dataType, ConfigurationAccessor accessor) Converts the given ConfigurationAccessor into an ActiveConfigurationData
AddressConfigurationData	toAddressConfiguration(ConfigurationAccessor accessor) Converts the given ConfigurationAccessor into an AddressConfigurationData
PhoneConfigurationData	toPhoneConfiguration(ConfigurationAccessor accessor) Converts the given ConfigurationAccessor into a PhoneConfigurationData
void	updateSitemapLastModified(Configuration configuration) Marks the configuration's sitemap as modified

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

getActiveConfiguration, getDefault, list

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

clearAccessorCache

void clearAccessorCache()
                        throws FrameworkException

It schedules a clear to the accessor cache.

Throws:

FrameworkException

createDefaultForNetwork

Configuration createDefaultForNetwork(Network network)
                                      throws FrameworkException

Creates the default configuration for the given network

Throws:

FrameworkException

getConfigurationTreePath

java.util.List<Configuration> getConfigurationTreePath(Configuration configuration)
                                                       throws FrameworkException

Returns the configuration tree path for the given configuration If the logged user is global then the global configurations will also be returned.

Throws:

FrameworkException

isPasswordTypeInUse

boolean isPasswordTypeInUse(PasswordType passwordType)
                            throws FrameworkException

Returns whether the given password type is used as access password or confirmation password by any channel configuration

Throws:

FrameworkException

listAll

java.util.List<Configuration> listAll()
                                      throws FrameworkException

Returns all configurations

Throws:

FrameworkException

listByThemeUsage

java.util.List<Configuration> listByThemeUsage(Theme theme,
                                             ThemeUsage usage)
                                               throws FrameworkException

Lists the configurations which uses the given theme under the given usage type

Throws:

FrameworkException

listVisible

java.util.List<Configuration> listVisible()
                                          throws FrameworkException

Returns the configurations which are visible by the logged administrator

Throws:

FrameworkException

removeGroup

void removeGroup(Group group)
                 throws FrameworkException

Removes a group from any configuration; usually done when the group is disabled, and not supposed to show up anymore. The group is removed from possibleInitialGroups and from visibleGroups.

Throws:

FrameworkException

setConfiguration

<T> void setConfiguration(Configuration configuration,
                        com.mysema.query.types.Path<T> path,
                        T value)
                      throws FrameworkException

Sets a configuration property and add it on the defined collection

Throws:

FrameworkException

setLocalization

void setLocalization(Configuration configuration,
                   Language language,
                   java.lang.String country,
                   java.lang.String timeZoneId)
                     throws FrameworkException

Sets the localization options in the given configuration, defining the language, country and time zone, as well as fields derived from the language and coutry, like date and number format.

Throws:

FrameworkException

sortByHierarchy

java.util.List<Configuration> sortByHierarchy(java.util.Collection<Configuration> configurations)
                                              throws FrameworkException

Sort the given configurations according to the hierarchy

Throws:

FrameworkException

toActiveConfiguration

<T extends ActiveConfigurationData> T toActiveConfiguration(java.lang.Class<T> dataType,
                                                          ConfigurationAccessor accessor)
                                                        throws FrameworkException

Converts the given ConfigurationAccessor into an ActiveConfigurationData

Throws:

FrameworkException

toAddressConfiguration

AddressConfigurationData toAddressConfiguration(ConfigurationAccessor accessor)
                                                throws FrameworkException

Converts the given ConfigurationAccessor into an AddressConfigurationData

Throws:

FrameworkException

toPhoneConfiguration

PhoneConfigurationData toPhoneConfiguration(ConfigurationAccessor accessor)
                                            throws FrameworkException

Converts the given ConfigurationAccessor into a PhoneConfigurationData

Throws:

FrameworkException

updateSitemapLastModified

void updateSitemapLastModified(Configuration configuration)
                               throws FrameworkException

Marks the configuration's sitemap as modified

Throws:

FrameworkException