diff --git a/offapi/com/sun/star/configuration/ConfigurationAccess.idl b/offapi/com/sun/star/configuration/ConfigurationAccess.idl
index e6e672b86b4b..06d0fdbcecf5 100644
--- a/offapi/com/sun/star/configuration/ConfigurationAccess.idl
+++ b/offapi/com/sun/star/configuration/ConfigurationAccess.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: ConfigurationAccess.idl,v $
*
- * $Revision: 1.8 $
+ * $Revision: 1.9 $
*
- * last change: $Author: jb $ $Date: 2001-02-05 14:39:42 $
+ * last change: $Author: arellano $ $Date: 2001-02-27 00:38:55 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -96,6 +96,8 @@ module com { module sun { module star { module configuration {
//=============================================================================
/** 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.
@@ -106,10 +108,13 @@ module com { module sun { module star { module configuration {
(and so on recursively).
+
+
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.
+ repository itself and is accessible through an implementation of this service.
Two different kinds of structural elements are used in the configuration
@@ -118,29 +123,31 @@ module com { module sun { module star { module configuration {
- Sets
- are dynamic containers of homogeneous elements. Which elements
- a set contains can vary; their names are defined by the
- clients that insert them. On the other hand the type of
+ a set contains can vary. Their names are defined by the
+ clients that insert them. On the other hand, the type of
the elements is the same for all elements. In the case of elements
that are themselves hierarchy objects, the type includes
the structure of the hierarchy fragment they contain. Such types
are defined in the configuration schema as
templates
.
+
+
- Groups
- are static collections of heterogeneous elements. The names and
- types of the elements a group are completely defined in the
- configuration schema. But here each element may be of a different
- type, allowing even groups that contain a mix of
+ types of the elements of a group are completely defined in the
+ configuration schema. Here each element may be of a different
+ type, allowing groups that contain a mix of
subobjects and simple values.
- Objects in the configuration hierarchy (i.e. implementations of this service)
+
Objects in the configuration hierarchy, for example, implementations of this service,
can thus be classified in the following ways:
- Container role:
- An object can hold child elements as a set or a group.
+ An object that can hold child elements as a set or a group.
- Element role:
An object may be an element of a set or a group
@@ -153,15 +160,18 @@ module com { module sun { module star { module configuration {
supported. The basic types are:
+
+
+
- string can hold a human-readable text.
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.
+ For binary data, use type binary instead.
- - boolean can hold the values or >FALSE/>.
+
- boolean can hold the values or .
Values are represented as boolean.
Sequences are represented as boolean.
@@ -187,6 +197,8 @@ module com { module sun { module star { module configuration {
+
+
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).
@@ -198,6 +210,9 @@ module com { module sun { module star { module configuration {
), its contents may be .
+
+
+
The configuration should support explicit access to default values
(implementing XPropertyState
and XPropertyWithState).
@@ -205,10 +220,10 @@ module com { module sun { module star { module configuration {
@see ConfigurationProvider
Root instances of this service can be requested from a
- ConfigurationProvider
+ ConfigurationProvider.
@see ConfigurationUpdateAccess
- , which is an extended service that includes facilities for modifying
+ an extended service that includes facilities for modifying
configuration data.
*/
service ConfigurationAccess
@@ -221,49 +236,59 @@ service ConfigurationAccess
Implementations shall implement exactly one of:
- - SetAccess if this element is a Set.
-
-
- GroupAccess if this element is a Group.
-
+
- SetAccess if this element is a Set.
+ - GroupAccess if this element is a Group.
*/
service HierarchyAccess;
/** provides interfaces to obtain information about this element and its
- role and context in the hierarchy
+ 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:
- AccessRootElement if this element is the
Root of the whole hierarchy. Objects that can be
created directly by a ConfigurationProvider
- implement this service.
-
+ implement this service.
- SetElement if this element may be contained in a
- Set.
-
-
- GroupElement if this element is child of a
- Group.
-
+ Set.
+ - GroupElement if this element is a child of a
+ Group.
+
*/
service HierarchyElement;
/** specializes HierarchyAccess,
if this element is a Set.
-
[Alternatively to GroupAccess]
+
This is an alternative to GroupAccess.
+
+
*/
/*[optional]*/ service SetAccess;
/** specializes HierarchyAccess,
if this element is a Group.
-
[Alternatively to SetAccess]
- */
+
This is an alternative to SetAccess.
+
+
+*/
/*[optional]*/ service GroupAccess;
/** specializes HierarchyElement,
if this element is the Root of the whole hierarchy.
-
[Alternatively to SetElement
- or GroupElement]
+
This is an alternative to SetElement
+ or GroupElement.
+
+
+
@see ConfigurationProvider
Instances obtained from a ConfigurationProvider will
@@ -273,16 +298,20 @@ service ConfigurationAccess
/** specializes HierarchyElement,
if this element may be contained in a Set.
-
[Alternatively to AccessRootElement
- or GroupElement]
- */
+
This is an alternative to AccessRootElement
+ or GroupElement.
+
+
+*/
/*[optional]*/ service SetElement;
/** specializes HierarchyElement,
- if this element is child of a Group.
-
[Alternatively to AccessRootElement
- or SetElement]
- */
+ if this element is a child of a Group.
+
This is an alternative to AccessRootElement
+ or SetElement.
+
+
+*/
/*[optional]*/ service GroupElement;
};