Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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

service SetAccess

Description
provides access to a dynamic, homogeneous set of values or nested trees within a (by name) hierarchy.

Also provides information about the template for elements. Allows normalizing externally generated names.

Sets here are dynamic containers within the hierarchy.

The number and names of contained elements are not fixed in advance, but all elements have to be of one predetermined type.

See also
com::sun::star::configuration::SetElement
Child objects of this service generally implement SetElement . The template name returned by the child from XTemplateInstance::getTemplateName corresponds to the name returned by the set from XTemplateContainer::getElementTemplateName .
See also
com::sun::star::configuration::GroupAccess
A complementary service that provides for static heterogeneous groups of elements within the hierarchy.


Included Services

com::sun::star::configuration::HierarchyAccess
Description
is the basic service for accessing child and descendent nodes in a hierarchy.

External names (from foreign namespaces) should be normalized using XStringEscape::escapeString (if available) before using them as element names.

com::sun::star::configuration::SimpleSetAccess
Description
is the basic service providing information about and access to elements of a not necessarily hierarchical set .

Interface XTemplateContainer , which is optional in SimpleSetAccess must always be implemented in this service, if the elements are of object type.

If an implementation handles naming restrictions transparently, it must also handle the case of element names embedded in hierarchical names - passed to any object in the hierarchy. Otherwise, the implementation should implement XStringEscape , in which case, the client is responsible for constructing correct hierarchical names.


Exported Interfaces

com::sun::star::container::XContainer
Description
allows attaching listeners to this node to monitor changes to the set.

In this service, support for notifications is mandatory.


Top of Page