Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

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

interface XBackend
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XBackend
Description
Handles access to layered data stored in a repository

Methods' Summary
getComponentSchema Returns the schema for a particular component.
listOwnLayers Returns the layers associated to the current entity for a component.
getOwnUpdateHandler Returns an update handler for the current entity layer for a component.
listLayers Returns the layers associated to an entity for a component.
getUpdateHandler Returns an update handler on an entity's layer for a component.
Methods' Details
getComponentSchema
XSchema
getComponentSchema(
 
[in] string 

raises(

 
aComponent ) 
BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description
Returns the schema for a particular component.
Parameter aComponent
component whose schema will be accessed
Returns
interface allowing access to the various parts of the schema
Throws
com::sun::star::lang::IllegalArgumentException if the component doesn't exist.
Throws
com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data.
listOwnLayers
sequence< XLayer >
listOwnLayers(
 
[in] string 

raises(

 
aComponent ) 
BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description
Returns the layers associated to the current entity for a component.
Parameter aComponent
component whose data will be accessed
Returns
list of interfaces allowing access to the component data for each layer associated to the current entity
Throws
com::sun::star::lang::IllegalArgumentException if the component doesn't exist.
Throws
com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data.
getOwnUpdateHandler
XUpdateHandler
getOwnUpdateHandler(
 
[in] string 

raises(

 
aComponent ) 
BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description
Returns an update handler for the current entity layer for a component.
Parameter aComponent
component whose data will be updated
Returns
interface allowing manipulation of the component data for the current entity
Throws
com::sun::star::lang::IllegalArgumentException if the component doesn't exist.
Throws
com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data.
listLayers
sequence< XLayer >
listLayers(
 
[in] string
[in] string 

raises(

 
aComponent,
aEntity ) 
BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description
Returns 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
list of interfaces allowing access to the component data for each layer associated with the entity
Throws
com::sun::star::lang::IllegalArgumentException if the component doesn't exist.
Throws
com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data.
getUpdateHandler
XUpdateHandler
getUpdateHandler(
 
[in] string
[in] string 

raises(

 
aComponent,
aEntity ) 
BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

Description
Returns 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
interface allowing manipulation of the component data for the entity
Throws
com::sun::star::lang::IllegalArgumentException if the component doesn't exist.
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.