:: com :: sun :: star :: configuration :: backend ::
|
service DataImporter |
- Description
- allows importing data from one configuration repository into another. .
- Since
- OOo 1.1.2
|
Exported Interfaces - Summary |
::com::sun::star::task::XJob |
allows running an import job
(details)
|
Exported Interfaces - Details |
::com::sun::star::task::XJob
- Description
- allows running an import job
The source and destination repositories are selected by arguments
passed to
::com::sun::star::task::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
::com::sun::star::task::XJob::execute()
that indicates the status of job execution. The type and meaning of
such status indicators depend on the implementation.
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 following arguments to
::com::sun::star::task::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 true, 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 true, 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
::com::sun::star::lang::IllegalArgumentException.
|
|
Top of Page
Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.