provides read/write access to a configuration data layer. More...
import"UpdatableLayer.idl";
Included Services | |
| service | Layer |
| handles read access to the contents of the layer. More... | |
Exported Interfaces | |
| interface | XUpdatableLayer |
| provides write access to the contents of the layer. More... | |
 Exported Interfaces inherited from Layer | |
| interface | XLayer |
| provides read access to the contents of the configuration layer. More... | |
| interface | XCompositeLayer |
| provides read access to sublayers accessible through an additional criterion (for instance the locale they contain data for). More... | |
| interface | com::sun::star::util::XTimeStamped |
| provides a way to detect changes to the layer. More... | |
Additional Inherited Members | |
| Public Member Functions inherited from XLayer | |
| void | readData ([in] XLayerHandler aHandler) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException, MalformedDataException) |
| describes the contents of the layer to an XLayerHandler. More... | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) |
| queries for a new interface to an existing UNO object. More... | |
| void | acquire () |
| increases the reference counter by one. More... | |
| void | release () |
| decreases the reference counter by one. More... | |
| Public Member Functions inherited from XUpdatableLayer | |
| void | replaceWith ([in] XLayer aNewLayer) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException, MalformedDataException) |
| Replaces the current layer with the layer given as input parameter. More... | |
| Public Attributes inherited from Layer | |
| string | URL |
| The URL of the layer data. More... | |
| Protected Member Functions inherited from XCompositeLayer | |
| sequence< string > | listSubLayerIds () raises (com::sun::star::lang::WrappedTargetException) |
| Returns a list of the criteria that can be used to access the sublayers. More... | |
| void | readSubLayerData ([in] XLayerHandler aHandler, [in] string aSubLayerId) raises (com::sun::star::lang::NullPointerException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException, MalformedDataException) |
| Describes the content of a particular sublayer to an XLayerHandler. More... | |
| Protected Member Functions inherited from XTimeStamped | |
| string | getTimestamp () |
| returns the timestamp of the object. More... | |
Detailed Description
provides read/write access to a configuration data layer.
A layer contains the configuration setting changes to be performed on a default layer (or schema) to obtain the values of those settings for a given entity and component.
An updatable layer can be read or replaced with another layer.
- Since
- OOo 1.1.2
Exported Interfaces
◆ Layer
| service Layer |
handles read access to the contents of the layer.
If the implementation supports com::sun::star::util::XTimeStamped, then after executing XUpdatableLayer::replaceWith() the timestamp will be the one for the replaced contents and if reading after updates is supported the next read will reproduce the replaced data.
Exported Interfaces
◆ XUpdatableLayer
| interface XUpdatableLayer |
provides write access to the contents of the layer.
Depending of the actual type (simple, i.e pure XLayer or composite, i.e XCompositeLayer) of the current layer and the provided replacement layer, the operation performed by XUpdatableLayer::replaceWith(), will vary.
For the different current/replacement layer combinations, we have:
- Simple/Simple
the provided layer's contents replace the current one's.
- Composite/Composite
all layers (main and sub) present in the provided layer are used to replace the corresponding current layer contents. Sublayers present in the current layer but not in the provided one are left untouched. Sublayers present in the provided layer but not in the current one are added to the current layer.
- Simple/Composite
the main layer and sublayers of the provided layer are merged into one whose contents replace the current layer.
- Composite/Simple
the provided layer is split into a composite one whose contents are then used to replace the current layer as described above.
Not all implementations of XUpdatableLayer support conversions of the replacement layer. In such a case the sublayers of the provided layer may be ignored or all simple data be merged into the main layer.
The documentation for this service was generated from the following file:
- com/sun/star/configuration/backend/UpdatableLayer.idl
