LibreOffice
LibreOffice 25.8 SDK API Reference
|
allows importing data from a local configuration data repository or file into any Backend. More...
import "LocalDataImporter.idl";
Included Services | |
service | DataImporter |
provides for running an import job |
Additional Inherited Members | |
Exported Interfaces inherited from DataImporter | |
interface | com::sun::star::task::XJob |
allows running an import job | |
Public Member Functions inherited from XJob | |
any | execute ([in] sequence< com::sun::star::beans::NamedValue > Arguments) raises ( com::sun::star::lang::IllegalArgumentException , com::sun::star::uno::Exception ) |
executes the job synchronously | |
Public Member Functions inherited from XInterface | |
any | queryInterface ([in] type aType) |
queries for a new interface to an existing UNO object. | |
void | acquire () |
increases the reference counter by one. | |
void | release () |
decreases the reference counter by one. |
allows importing data from a local configuration data repository or file into any Backend.
Data to be imported can be a single layer either from a full local configuration database or from a particular OOR Update XML file.
Data is imported into the DefaultBackend.
service DataImporter |
provides for running an import job
The implementation returns VOID from com::sun::star::task::XJob::execute() to indicates successful execution. If import is not executed, because OverwriteExisting =
TRUE was specified, a com::sun::star::lang::IllegalAccessException is returned.
If VOID or TRUE is returned, this indicates successful execution. If an com::sun::star::uno::Exception is returned, it represents an error condition encountered during execution.
The standard arguments to com::sun::star::task::XJob::execute() are all supported by implementations. Additionally the following argument is required to select the data source:
LayerDataUrl
: string A file URL that specifies the location of the source data.
If no Component
is provided, this must be the location of an OOR Update XML file, which will be imported directly.
If a Component
is provided, the LayerDataUrl
is treated as Entity (i.e. Layer directory base URL) for a local configuration database and the appropriate component from that repository is imported.
Implementations may support additional parameters to select a destination Backend, that is not the DefaultBackend.