LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XLayerImporter Interface Referencepublished

allows importing a layer into a Backend More...

import"XLayerImporter.idl";

Inheritance diagram for XLayerImporter:
XInterface Importer CopyImporter MergeImporter

Public Member Functions

XBackend getTargetBackend ()
 gets the target backend for importing. More...
 
void setTargetBackend ([in] XBackend aBackend) raises (com::sun::star::lang::NullPointerException)
 sets the target backend for importing. More...
 
void importLayer ([in] XLayer aLayer) raises (MalformedDataException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException)
 Imports the layer given into the backend. More...
 
void importLayerForEntity ([in] XLayer aLayer, [in] string aEntity) raises (MalformedDataException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::NullPointerException, com::sun::star::lang::WrappedTargetException)
 Imports the layer given into the backend for a given entity. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

allows importing a layer into a Backend

Since
OOo 1.1.2

Member Function Documentation

XBackend getTargetBackend ( )

gets the target backend for importing.

Returns
the Backend into which layers are imported by XLayerImporter::importLayer().

Imports the layer given into the backend.

This method imports data for the current entity of the backend.

Parameters
aLayera layer whose data will be imported into the backend
Exceptions
com::sun::star::lang::NullPointerExceptionif the layer passed is NULL or no backend is available.
com::sun::star::configuration::backend::MalformedDataExceptionif the layer passed is invalid
com::sun::star::lang::IllegalArgumentExceptionif the layer passed is for a component that doesn't exist in the backend
com::sun::star::lang::WrappedTargetExceptionif an error occurs in the backend or source layer.
See also
com::sun::star::configuration::backend::XBackend::getOwnUpdateHandler()

Imports the layer given into the backend for a given entity.

This method imports data for the current entity of the backend.

Parameters
aLayera layer whose data will be imported into the backend
aEntitya entity into whose data the layer will be imported
Exceptions
com::sun::star::lang::NullPointerExceptionif the layer passed is NULL or no backend is available.
com::sun::star::configuration::backend::MalformedDataExceptionif the layer passed is invalid
com::sun::star::lang::IllegalArgumentExceptionif the layer passed is for a component that doesn't exist in the backend or if the entity doesn't exist in the backend.
com::sun::star::lang::WrappedTargetExceptionif an error occurs in the backend or source layer.
See also
com::sun::star::configuration::backend::XBackend::getUpdateHandler()
void setTargetBackend ( [in] XBackend  aBackend)
raises (com::sun::star::lang::NullPointerException
)

sets the target backend for importing.

Parameters
aBackenda Backend into which layers should be imported by XLayerImporter::importLayer().
Exceptions
com::sun::star::lang::NullPointerExceptionif the backend passed is NULL.

The documentation for this interface was generated from the following file: