/************************************************************** * * 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 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. * *************************************************************/ #ifndef __com_sun_star_configuration_backend_DataImporter_idl__ #define __com_sun_star_configuration_backend_DataImporter_idl__ #ifndef __com_sun_star_task_XJob_idl__ #include #endif //============================================================================= module com { module sun { module star { module configuration { module backend { //============================================================================= /** allows importing data from one configuration repository into another. . @since OpenOffice 1.1.2 */ published service DataImporter { //------------------------------------------------------------------------- /** allows running an import job

The source and destination repositories are selected by arguments passed to XJob::execute(). The names and meanings of such arguments depend on the implementation. Each implementation must document such arguments.

Implementations may return a value from XJob::execute() that indicates the status of job execution. The type and meaning of such status indicators depend on the implementation.

If or is returned, this indicates successful execution. If an Exception is returned, it represents an error condition encountered during execution.

The following arguments to XJob::execute() should be supported by implementations. Implementations must document a failure to support any of these arguments:

ImporterService : string
A service or implementation name used to instantiate the Importer to use for importing. If this parameter is missing, the implementation selects an appropriate importer. By default, a MergeImporter should be used.
OverwriteExisting : boolean
If , specifies that no existing data should be overwritten by the import. If the Importer used does not support such protection, an error may be raised. If some data is not imported, because there is existing data, this is indicated by returning an appropriate exception.
TruncateExisting : boolean
If , specifies that existing data should be discarded and replaced by the imported data. If the Importer used does not support this operation, an error may be raised. By default, a CopyImporter is used to perform truncating import.
Entity : string
An identifier for the entity in the destination backend for which the imported data should apply. The value will be passed to XLayerImporter::importLayerForEntity(). If this parameter is missing, the implementation uses XLayerImporter::importLayer() instead.
Component : string
Names the component for which to import data. If this parameter is missing, the selection of data to import depends on implementation-specific parameters.
LayerFilter : LayerFilter
A filter to transform data during import. This parameter is optional. If this parameter is missing, data will be imported unaltered. Support for this parameter is optional. If the implementation does not support a filter it will raise an IllegalArgumentException.

*/ interface com::sun::star::task::XJob ; //------------------------------------------------------------------------- } ; //============================================================================= } ; } ; } ; } ; } ; #endif