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

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

service UpdateRootElement

Description
provides update control for a (by name) hierarchy and information about the hierarchy as a whole as well as its root.

Extends AccessRootElement by adding support for collecting changes and applying them to a backend store as a single batch.

An implementation represents the root of a partial hierarchy. [See the documentation for AccessRootElement ]. The hierarchy in turn is a view onto a fragment of persistent data tree that can be accessed through several such views, or even several processes, simultaneously.

Elements of the hierarchy, such as descendants of this root element, may support modification by providing appropriate interfaces. Changes done this way initially only affect these objects themselves and other objects within the same hierarchy, such as other descendants of this root element.

The accumulated changes within this hierarchy can be managed using XChangesBatch . Pending changes will become persistent and visible from other overlapping hierarchies only when XChangesBatch::commitChanges is called. If the hierarchy is disposed or discarded without committing changes, the changes will be lost.

See also
com::sun::star::configuration::GroupUpdate;
See also
com::sun::star::configuration::SetUpdate;


Included Services

com::sun::star::configuration::AccessRootElement
Description
provides (read-only) access to information about the root element of (a fragment of) the hierarchy. It also provides some functionality concerning the hierarchy (fragment) accessible from that element as a whole.

Exported Interfaces

com::sun::star::util::XChangesBatch
Description
allows managing changes within the hierarchy.

XChangesBatch::getPendingChanges reports all changes within the hierarchy that are done through (direct or indirect) descendants of this element. The same set of changes is committed to persistent storage and/or made visible to other objects accessing the same data set, when XChangesBatch::commitChanges is invoked.

If the implementation supports XLocalizable::setLocale , changes will be considered to apply to the locale that is set when XChangesBatch::commitChanges is invoked.

@ see AccessRootElement @ see com::sun::star::util::XChangesNotifier

Top of Page