Language
Asturianu (ast)
Català (ca)
Čeština (cs)
Dansk (da)
Deutsch (de)
English [US] (en-US)
Español (es)
Esperanto (eo)
Eesti keel (et)
Euskara (eu)
Français (fr)
Gàidhlig (gd)
Galego (gl)
Italiano (it)
Lietuvių (lt)
Magyar (hu)
Nederlands (nl)
Norsk (no)
Polski (pl)
Português [do Brasil] (pt-BR)
Português [Europeu] (pt)
Română (ro)
Slovenčina (sk)
Slovenščina (sl)
Suomi (fi)
Svenska (sv)
Yкраїнська (uk)
Tiếng Việt (vi)
Türkçe (tr)
ኦሮሚኛ (om)
Հայերեն (hy)
Ελληνικά (el)
български език (bg)
Русский (ru)
Cрпски [ћирилицом] (sr)
עברית (he)
हिन्दी (hi)
ភាសាខ្មែរ (km)
தமிழ் (ta)
ภาษาไทย (th)
简体中文 (zh-CN)
正體中文 (zh-TW)
日本語 (ja)
한국어 (ko)
:: drafts :: com :: sun :: star :: configuration :: backend ::
interface XSingleBackend
Base Hierarchy ::com::sun::star::uno::XInterface
|
+-XSingleBackend
Description
Handles access to a single layer of data in a repository
with timestamp-checking capabilities.
Methods' Summary
listLayerIds
Provides the list of layers involved with an entity for a component.
getUpdateLayerId
Provides the updateable layer id associated with an entity
for a component.
getOwnId
Provides the entity id of the current entity.
getLayer
Returns the layer data associated to a layer id
if newer than indicated.
getLayers
Returns the layers associated to a series of layer ids
if newer that indicated. A timestamp is provided to be
used for all the layers.
getMultipleLayers
Returns the layers associated to a series of layer ids if newer
than indicated. Each layer has an individual timestamp to which
the current layer date is compared to decide if it is returned.
getUpdatableLayer
Returns the writable layer associated to a layer id.
getWriteHandler
Returns the write-access layer handler associated with
a layer id. The layer id has been provided by the getUpdateLayerId
method.
getSchema
Returns the schema information (component + templates)
for a component.
Methods' Details
listLayerIds
sequence< string >listLayerIds (
raises(
BackendAccessException ,
Description
Provides the list of layers involved with an entity for a component.
Parameter aComponent component being accessed
Parameter aEntity entity being accessed
Returns list of layer identifiers that can be used to
retrieve associated layer data
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the component doesn't exist.
getUpdateLayerId
stringgetUpdateLayerId (
raises(
BackendAccessException ,
Description
Provides the updateable layer id associated with an entity
for a component.
Parameter aComponent component being accessed
Parameter aEntity entity being accessed
Returns layer identifier that can be used to obtain
a layer handler to describe the new value of the layer
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the component doesn't exist.
getOwnId
Description
Provides the entity id of the current entity.
Returns entity identifier for the current entity
getLayer
XLayer getLayer ( raises(
BackendAccessException ,
Description
Returns the layer data associated to a layer id
if newer than indicated.
Parameter aLayerId identifier of the layer to be accessed
Parameter aTimestamp timestamp to compare the layer to
Returns accessor on the layer data
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the layer id is invalid.
getLayers
sequence< XLayer >getLayers (
raises(
BackendAccessException ,
Description
Returns the layers associated to a series of layer ids
if newer that indicated. A timestamp is provided to be
used for all the layers.
Parameter aLayerIds identifiers of the layers to be accessed
Parameter aTimestamp timestamp to compare the layers to
Returns list of layer data accessors aligned on aLayerIds
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the layer id is invalid.
getMultipleLayers
sequence< XLayer >getMultipleLayers (
raises(
BackendAccessException ,
Description
Returns the layers associated to a series of layer ids if newer
than indicated. Each layer has an individual timestamp to which
the current layer date is compared to decide if it is returned.
Parameter aLayerIds identifiers of the layers to be accessed
Parameter aTimestamps timestamps for each of the layers, this list
must be aligned on aLayerIds
Returns list of layer data accessors aligned on aLayerIds
Throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the backend.
Throws com::sun::star::lang::IllegalArgumentException
if one of the layer ids is invalid or if there are not enough
timestamps.
getUpdatableLayer
Description
Returns the writable layer associated to a layer id.
Parameter aLayerId identifier of the writable layer to be accessed
Returns updatable layer interface
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the layer id is invalid.
getWriteHandler
Description
Returns the write-access layer handler associated with
a layer id. The layer id has been provided by the getUpdateLayerId
method.
Parameter aLayerId identifier of the layer to be updated
Returns layer handler used to describe the new contents of the layer
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the layer id is invalid.
getSchema
Description
Returns the schema information (component + templates)
for a component.
Parameter aComponent component whose schema is being accessed
Returns accessor to the schema data
Throws com::sun::star::configuration::backend::BackendAccessException
if access to the backend fails.
Throws com::sun::star::lang::IllegalArgumentException
if the component doesn't exist.
Top of Page Copyright © 2003 Sun Microsystems, Inc.
