service GroupAccess in module com::sun::star::configuration::

(Global Index)

Syntax

service GroupAccess;

Description

provides access to a predefined heterogeneous group of values and nested trees as part of a (by name) hierarchy.

Provides access to, and information about, its children and descendants viewed either as properties or as contained elements.

Groups are static collections within the hierarchy.

The number and names of contained elements are fixed in advance and each child may have a different type.

This service subsumes two alternate ways of accessing child and descendent elements. These strongly overlap, supporting the basic identity xGroup.getPropertyValue( aName ) == xGroup.getByName( aName ) .

See also

GroupElement
Child objects of this service generally implement service GroupElement.

See also

SetAccess
A complementary service providing for dynamic homogeneous sets of elements.

Included Services

com::sun::star::configuration::HierarchyAccess

Description

is the basic service for accessing child and descendent nodes using a view of the tree as a container of values and structuring elements.


com::sun::star::configuration::PropertyHierarchy

Description

is the basic service for accessing child and descendent nodes using a view of the tree as a hierarchy of properties and subproperties.

This view is meaningful only for a static fragment of the hierarchy Objects' properties may change, but not which properties they have. Therefore, dynamic elements of the hierarchy (see SetAccess ) do not implement service PropertyHierarchy .

If such elements occur as properties or subproperties of an implementation, it is not specified whether direct subproperty access using XHierarchicalPropertySet or XMultiHierarchicalPropertySet can be used to access descendants of such elements.

Similarly, information about such descendants may not be available from the XHierarchicalPropertySetInfo the implementation provides.

If an implementation is part of a read-only view of the hierarchy, all properties and subproperties will be reported as having attribute PropertyAttribute::READONLY set, and attempts to change property values will fail.


Exported Interfaces

com::sun::star::beans::XPropertyState [ OPTIONAL ]

Description

provides access to the state of child elements of an implementation. [optional]

This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values.

If elements that are not simple values, but objects themselves, support a default state (as indicated by PropertyAttribute::MAYBEDEFAULT ), they should implement XPropertyWithState , in which case the PropertyState applies to all their children and recursively to all descendants.

If an implementation is part of a read-only view of the hierarchy, attempts to change property states will fail.


com::sun::star::beans::XMultiPropertyStates [ OPTIONAL ]

Description

provides access to the states of multiple child elements of an implementation. [optional]

This interface may be missing if the hierarchy (or a hierarchy fragment that contains this implementation as element) does not support default values, or if the implementation does not support recursive defaults (see below).

If elements that are not simple values, but objects themselves, support a default state (as indicated by PropertyAttribute::MAYBEDEFAULT ), they should implement XPropertyWithState , in which case the PropertyState applies to all their children and recursively to all descendants.

If an implementation is part of a read-only view of the hierarchy, attempts to change property states will fail.


Top of Page