From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- .../configuration/backend/LocalDataImporter.idl | 98 ++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 offapi/com/sun/star/configuration/backend/LocalDataImporter.idl (limited to 'offapi/com/sun/star/configuration/backend/LocalDataImporter.idl') diff --git a/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl new file mode 100644 index 000000000..a3b2bdd3e --- /dev/null +++ b/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl @@ -0,0 +1,98 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_configuration_backend_LocalDataImporter_idl__ +#define __com_sun_star_configuration_backend_LocalDataImporter_idl__ + +#include + + +module com { module sun { module star { module configuration { module backend { + + +/** + 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. +

+ + @see com::sun::star::configuration::backend::LocalHierarchyBrowser + Service that can be used to locate available layer files or components. + + @see com::sun::star::configuration::backend::LocalSingleBackend + Service that can be used to access a local configuration database. + + @since OOo 1.1.2 +*/ +published service LocalDataImporter +{ + + /** 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. +

+ */ + service DataImporter ; + +} ; + + +} ; } ; } ; } ; } ; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3