:: com :: sun :: star :: configuration :: backend ::
|
interface XBackend |
|
- Description
- Handles access to layered data stored in a repository.
Data can be retrieved on behalf of one or more entities.
There is an implied owner entity associated to the object
when it is created. This entity should be used for normal data access.
For administrative operations data of other entities can be accessed.
- Since
- OOo 1.1.2
- See also
- XBackendEntities, XSchemaSupplier
|
Methods' Summary |
listOwnLayers |
retrieves the layers associated to the owner
entity for a component.
|
getOwnUpdateHandler |
creates an update handler for the owner entity
layer for a component.
|
listLayers |
retrieves the layers associated to an entity for a component.
|
getUpdateHandler |
creates an update handler on an entity's layer for a component.
|
Methods' Details |
listOwnLayers
- Description
- retrieves the layers associated to the owner
entity for a component.
- Parameter aComponent
- component whose data will be accessed
- Returns
- a list of objects allowing access to the
component data for each layer associated to
the current entity
- Throws
- com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid
- Throws
- com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
- See also
- XBackendEntities::getOwnerEntity()
|
|
getOwnUpdateHandler
- Description
- creates an update handler for the owner entity
layer for a component.
- Parameter aComponent
- component whose data will be updated
- Returns
- an object allowing manipulation of the
component data for the current entity
- Throws
- com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid
- Throws
- com::sun::star::lang::NoSupportException
if updates are not supported for this backend
- Throws
- com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
- See also
- XBackendEntities::getOwnerEntity()
|
|
listLayers
- Description
- retrieves the layers associated to an entity for a component.
- Parameter aComponent
- component whose data will be accessed
- Parameter aEntity
- entity whose data will be accessed
- Returns
- a list of objects allowing access to the
component data for each layer associated
with the entity.
- 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
- XBackendEntities::supportsEntity()
|
|
getUpdateHandler
- Description
- creates an update handler on an entity's layer for a component.
- Parameter aComponent
- component whose data will be updated
- Parameter aEntity
- entity whose data will be updated
- Returns
- an object allowing manipulation of the
component data for the entity
- 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 updates are not supported for this backend
- Throws
- com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the data.
- See also
- XBackendEntities::supportsEntity()
|
|
Top of Page
Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.