service ConfigurationAccess in module com::sun::star::configuration:: |
service ConfigurationAccess;
provides (read) access to a fragment of the configuration hierarchy.
Values that are direct or indirect descendants of a root element can be retrieved and, if themselves objects, navigated. Other interfaces provide access to information about this element and its context. Changes to values in the hierarchy can be monitored by event listeners.
Descendants of this service also implement this service.
Ultimately the configuration holds values. These values are organized into a hierarchy using structural elements. The structure is defined in advance in a schema. Necessary information from the schema is stored in the configuration repository itself and is accessible through an implementation of this service.
Two different kinds of structural elements are used in the configuration hierarchy:
Objects in the configuration hierarchy, for example, implementations of this service, can thus be classified in the following ways:
Several types of simple values can be used in the configuration. In addition to the basic (scalar) types, sequences of the basic types are supported. The basic types are:
Values are represented as string
.
Sequences are represented as string
[] .
' human-readable ' here excludes non-printing characters except for CR, LF and TAB [Unicode code points 9,10,13]. For binary data, use type binary instead.
Values are represented as boolean
.
Sequences are represented as boolean
[] .
Values are represented as short
.
Sequences are represented as short
[] .
Values are represented as long
.
Sequences are represented as long
[] .
Values are represented as hyper
.
Sequences are represented as hyper
[] .
Values are represented as double
.
Sequences are represented as double
[] .
Values are represented as byte
[] .
Sequences are represented as byte
[][] .
Within templates an additional type any can occur. When
such a template is used to create a new SetElement , the type
of the element is initially reported as any
(having no value).
When the value of such an element is first set, it will assume the type used.
If the schema marks a value as nullable (which is indicated by attribute PropertyAttribute::MAYBEVOID ), its contents may be NULL .
The configuration should support explicit access to default values (implementing XPropertyState and XPropertyWithState ).
Included Services |
provides interfaces to access child and descendent elements.
An implementation actually implements a specialization of this service, which depends on its Container role.
Implementations shall implement exactly one of:
provides interfaces to obtain information about this element and its role and context in the hierarchy.
An implementation actually implements a specialization of this service, which depends on its Element role.
Implementations shall implement exactly one of:
specializes HierarchyAccess , if this element is a Set .
This is an alternative to GroupAccess . / * [optional]
specializes HierarchyAccess ,
if this element is a Group .
This is an alternative to SetAccess .
specializes HierarchyElement ,
if this element is the Root of the whole hierarchy.
This is an alternative to SetElement
or GroupElement .
specializes HierarchyElement ,
if this element may be contained in a Set .
This is an alternative to AccessRootElement
or GroupElement .
specializes HierarchyElement ,
if this element is a child of a Group .
This is an alternative to AccessRootElement
or SetElement .
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.