org.universAAL.middleware.managers.api

Interface ConfigurationEditor

All Known Implementing Classes:

ConfigurationManagerImpl

public interface ConfigurationEditor

Configuration Edition user interfaces should look for this service to enable remote or local configuration of ConfigurableModules.

Author:

amedrano

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConfigurationEditor.ConfigurableEntityManager An interface to receive asynchronously the ConfigurableEntityEditors.

Method Summary

Modifier and Type	Method and Description
List<ConfigurableEntityEditor>	getMatchingConfigurationEditors(List<EntityPattern> configPattern, Locale locale) Get all the individual ConfigurableEntities to configure each matching DescribedEntity.
void	registerConfigurableEntityManager(ConfigurationEditor.ConfigurableEntityManager manager, List<EntityPattern> configPattern, Locale locale) Subscribe asynchronously to all the all the individual ConfigurableEntities to configure each matching DescribedEntity.
void	unRegisterConfigurableEntityManager(ConfigurationEditor.ConfigurableEntityManager manager) Unregister a previously registered ConfigurationEditor.ConfigurableEntityManager, it un registers all configPattern registered.

Method Detail

getMatchingConfigurationEditors

List<ConfigurableEntityEditor> getMatchingConfigurationEditors(List<EntityPattern> configPattern,
                                                               Locale locale)

Get all the individual ConfigurableEntities to configure each matching DescribedEntity. This call is done synchronously, internally it will call the asynchronous method, and wait for all the responses.

Parameters:

configPattern - the matching entities pattern, to get only the corresponding ConfigurableEntityEditors of those entities. use Empty list to get all.

locale - the preferred locale for descriptions.

Returns:

a list of ConfigurableEntityEditors corresponding to matching Entities.

registerConfigurableEntityManager

void registerConfigurableEntityManager(ConfigurationEditor.ConfigurableEntityManager manager,
                                       List<EntityPattern> configPattern,
                                       Locale locale)

Subscribe asynchronously to all the all the individual ConfigurableEntities to configure each matching DescribedEntity.

Parameters:

manager - the listener to be called asynchronously when a new matching DescribedEntity is found.

configPattern - the pattern to match DescribedEntities .

locale - the preferred language of the manager.

unRegisterConfigurableEntityManager

void unRegisterConfigurableEntityManager(ConfigurationEditor.ConfigurableEntityManager manager)

Unregister a previously registered ConfigurationEditor.ConfigurableEntityManager, it un registers all configPattern registered.

Parameters:

manager -

configPattern -