org.universAAL.middleware.interfaces.configuration.configurationDefinitionTypes

Interface DescribedEntity

All Known Subinterfaces:

ConfigurableEntityEditor, ConfigurationFile, ConfigurationFileEditor, ConfigurationParameter, ConfigurationParameterEditor

All Known Implementing Classes:

ConfigurationDefinedElsewhere

public interface DescribedEntity

A DescribedEntity is an Entity that is restricted to certain Scope and has a description.

Author:

amedrano

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription(Locale loc) Description of the entity.
Scope	getScope() Define the ID and Scope for this Entity.

Method Detail

getScope

Scope getScope()

Define the ID and Scope for this Entity.

• AALSpaceScope defines that this entity is applicable over the whole AALSpace, so when managed its value will be the same on the whole AALSpace.
• InstanceScope defines that this entity is only applicable for the instance given in the scope.
• ModuleScope the entity is only applicable for the given module and instance.
• ApplicationScope defines that this entity is applicable over a certain application, this will be shared over the whole AALSpace for the same application.
• AppPartScope same as ApplicationScope but with finer grain, for application parts.

Returns:

a valid scope.

getDescription

String getDescription(Locale loc)

Description of the entity. It can be localized so the description can be given in different languages.

Parameters:

loc - the preferred locale for the description.

Returns:

the Description of the entity.