Methods' Details |
listLayerIds
- Description
- identifies the layers within this stratum which should be read and
merged to determine data of a component for an entity
- Parameter aComponent
- The name of the component to access.
- Parameter aEntity
- The name of an entity on behalf of which data will be accessed.
- Returns
- a list of layer identifiers that can be used to
retrieve Layer objects.
The list ist ordered by priority. Typically
the most general layers (global defaults,
entire organization) are first, more specific layers
(associated to specific groups or roles) are next
and the entity's own data is last.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid or
if the entity doesn't exist.
- Throws
- com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
- See also
- XMultiLayerStratum::getLayer(), XMultiLayerStratum::getLayers(), XMultiLayerStratum::getMultipleLayers(), XBackendEntities
|
|
getUpdateLayerId
- Description
- identifies the layer which should be modified
to update data of a component on behalf of an entity.
The layer id returned is one of the layer ids obtained from
XMultiLayerStratum::listLayerIds() for the same
component and entity.
- Parameter aComponent
- The name of the component to access.
- Parameter aEntity
- The name of an entity on behalf of which data will be accessed.
- Returns
- a layer identifier that can be used to obtain
an UpdatableLayer object.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid or
if the entity doesn't exist.
- 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.
- See also
- XMultiLayerStratum::getUpdatableLayer(), XBackendEntities
|
|
getLayer
- Description
- retrieves a layer associated to a layer id, 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 aLayerId
- identifier of the layers to be accessed.
Layer ids can be obtained from
XMultiLayerStratum::listLayerIds() or
XMultiLayerStratum::getUpdateLayerId().
- 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 layer id 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
|
|
getLayers
- Description
- retrieves the layers associated to a series of layer ids,
if newer than indicated.
A timestamp can be provided, which is used to indicate
a point in time. Only layers that are modified since that time
should be returned. The same timestamp is used for all layers.
- Parameter aLayerIds
- identifiers of the layers to be accessed.
Layer ids can be obtained from
XMultiLayerStratum::listLayerIds().
- Parameter aTimestamp
- a timestamp for all of the layers.
An empty timestamp indicates, that the layers should be
retrieved irrespective of their 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 list of Layer objects
providing access to the layer data.
The list has the same length as aLayerIds. Each layer
object is associated to the layer id in the corresponding
position.
For layers that are newer than indicated by the
timestamp, the list contains a NULL element.
- Throws
- com::sun::star::lang::IllegalArgumentException
if one of the layer ids 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
|
|
getMultipleLayers
- Description
- retrieves the layers associated to a series of layer ids,
if newer than indicated for each layer.
For each layer an individual timestamp can be provided,
which is used to indicate the last known version of the layer.
Only layers that are modified since that time should be returned.
- Parameter aLayerIds
- identifiers of the layers to be accessed.
Layer ids can be obtained from
XMultiLayerStratum::listLayerIds().
- Parameter aTimestamps
- timestamps for each of the layers.
This list must have the same length as aLayerIds.
Timestamps are matched to layer ids by their position.
An empty timestamp indicates, that the associated 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 list of Layer objects
providing access to the layer data.
The list has the same length as aLayerIds. Each layer
object is associated to the layer id in the corresponding
position.
For layers that are newer than indicated by the corresponding
timestamp, the list contains a NULL element.
- Throws
- com::sun::star::lang::IllegalArgumentException
if one of the layer ids is invalid or
if one of the timestamps is invalid or
if the lengths of the arguments don't match.
- Throws
- com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
- See also
- ::com::sun::star::util::XTimeStamped
|
|
getUpdatableLayer
- Description
- retrieves a writable representation of the layer
associated to a layer id.
- Parameter aLayerId
- identifier of the layer to be accessed for writing.
A layer id for writing can be obtained from
XMultiLayerStratum::getUpdateLayerId().
- Returns
- an UpdatableLayer object providing
write access to the layer
- Throws
- com::sun::star::lang::IllegalArgumentException
if the layer id 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.
|
|
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.