Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.10

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

interface XSingleLayerStratum
Description
Handles access to a stratum consisting of a single layer in a configuration data repository

The interface provides timestamp-checking capabilities for efficient caching.

Since
OOo 1.1.2
See also
::com::sun::star::util::XTimeStamped, XSchemaSupplier, XMultiLayerStratum

Methods' Summary
getLayer retrieves the layer data for a component, if newer than indicated.  
getUpdatableLayer retrieves a writable representation of the layer for a component.  
Methods' Details
getLayer
XLayer
getLayer( [in] string  aComponent,
[in] string  aTimestamp )
raises( BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description
retrieves the layer data for a component, if newer than indicated.

A timestamp can be provided, which is used to indicate a point in time. The layer should be returned only if is modified since that time.

Parameter aComponent
The name of the component to access.
Parameter aTimestamp
a timestamp for the layer.

An empty timestamp indicates, that the layer should be retrieved irrespective of its modification time.

The format and meaning of a timestamp depends on the implementation. Timestamps can be obtained using ::com::sun::star::util::XTimeStamped::getTimestamp().

Returns
a Layer object providing access to the layer data, NULL if the layer is newer than indicated by the timestamp.
Throws
com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or if the timestamp is invalid.
Throws
com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data.
See also
::com::sun::star::util::XTimeStamped
getUpdatableLayer
XUpdatableLayer
getUpdatableLayer( [in] string  aComponent )
raises( BackendAccessException,
::com::sun::star::lang::NoSupportException,
::com::sun::star::lang::IllegalArgumentException );

Description
retrieves a writable representation of the layer for a component.
Parameter aComponent
The name of the component to access.
Returns
an UpdatableLayer object providing write access to the layer
Throws
com::sun::star::lang::IllegalArgumentException if the component identifier is invalid.
Throws
com::sun::star::lang::NoSupportException if the implementation does not support updates.
Throws
com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.