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

interface XBackend

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
sequence< XLayer >
listOwnLayers( [in] string  aComponent )
raises( BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

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
XUpdateHandler
getOwnUpdateHandler( [in] string  aComponent )
raises( BackendAccessException,
::com::sun::star::lang::NoSupportException,
::com::sun::star::lang::IllegalArgumentException );

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
sequence< XLayer >
listLayers( [in] string  aComponent,
[in] string  aEntity )
raises( BackendAccessException,
::com::sun::star::lang::IllegalArgumentException );

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
XUpdateHandler
getUpdateHandler( [in] string  aComponent,
[in] string  aEntity )
raises( BackendAccessException,
::com::sun::star::lang::NoSupportException,
::com::sun::star::lang::IllegalArgumentException );

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