org.cyclos.impl.system

Interface ConfigurationServiceLocal

All Superinterfaces:

ConfigurationService, CRUDService<ConfigurationDTO,ConfigurationData,ConfigurationVO>, CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,ConfigurationVO>, Service

public interface ConfigurationServiceLocal
extends ConfigurationService, CRUDServiceLocal<Configuration,ConfigurationDTO,ConfigurationData,ConfigurationVO>

Local interface for configuration

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	UNACCENT Name of the default dictionary

Method Summary

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.
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.querydsl.core.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

Field Detail

UNACCENT

static final java.lang.String UNACCENT

Name of the default dictionary

See Also:

Constant Field Values

Method Detail

clearAccessorCache

void clearAccessorCache()

It schedules a clear to the accessor cache.

createDefaultForNetwork

Configuration createDefaultForNetwork(Network network)

Creates the default configuration for the given network

getConfigurationTreePath

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.

listAll

java.util.List<Configuration> listAll()

Returns all configurations

listByThemeUsage

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

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

listVisible

java.util.List<Configuration> listVisible()

Returns the configurations which are visible by the logged administrator

removeGroup

void removeGroup(Group group)

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.

setConfiguration

<T> void setConfiguration(Configuration configuration,
                          com.querydsl.core.types.Path<T> path,
                          T value)

Sets a configuration property and add it on the defined collection

setLocalization

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.

sortByHierarchy

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

Sort the given configurations according to the hierarchy

toActiveConfiguration

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

Converts the given ConfigurationAccessor into an ActiveConfigurationData

toAddressConfiguration

AddressConfigurationData toAddressConfiguration(ConfigurationAccessor accessor)

Converts the given ConfigurationAccessor into an AddressConfigurationData

toPhoneConfiguration

PhoneConfigurationData toPhoneConfiguration(ConfigurationAccessor accessor)

Converts the given ConfigurationAccessor into a PhoneConfigurationData

updateSitemapLastModified

void updateSitemapLastModified(Configuration configuration)

Marks the configuration's sitemap as modified