:: 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 © 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.