public interface ImportOperation
file system
.Modifier and Type | Interface and Description |
---|---|
static interface |
ImportOperation.DatabaseLayerMapper
Deprecated.
since 5.2.513 - use
LayerMapper instead |
static class |
ImportOperation.MapDatabaseLayerMapper
Deprecated.
since 5.2.513 - use
LayerMapper instead |
static interface |
ImportOperation.Problem
|
static interface |
ImportOperation.Result
Container providing access to the result of the import operation.
|
Modifier and Type | Field and Description |
---|---|
static ImportOperation.DatabaseLayerMapper |
IDENTITY_LAYER_MAPPING
Deprecated.
since 5.2.513 - use
LayerMapper instead |
static OperationType<ImportOperation> |
TYPE
Operation providing means to import store elements from files in a
file system . |
Modifier and Type | Method and Description |
---|---|
ImportOperation.Result |
perform(FileSystem<?> fileSystem)
Perform the import on the given
file system . |
void |
setCreateEntities(boolean enable)
Deprecated.
since 5.2.410, replaced by
setIgnoreEntities(boolean) |
void |
setDatabaseLayerMapper(ImportOperation.DatabaseLayerMapper mapper)
Deprecated.
since 5.2.513 - use
setLayerMapper(LayerMapper) instead |
void |
setIgnoreEntities(boolean ignore)
Defines to ignore entities when importing.
|
void |
setImportFilter(Filter<ImportElementInfo> filter)
Sets a filter being used to decide upon elements to be imported.
|
void |
setImportScheduleEntryActiveState(boolean importScheduleEntryActiveState)
|
void |
setLayerMapper(LayerMapper layerMapper)
Sets a mapper providing information to map imported schemes to a specific layer of the target project.
|
void |
setRevisionComment(String comment)
Sets a comment for revisions created
during the update . |
void |
setStepsListener(StepsListener listener)
Sets the listener that gets informed on steps being started.
|
static final OperationType<ImportOperation> TYPE
file system
.@Deprecated static final ImportOperation.DatabaseLayerMapper IDENTITY_LAYER_MAPPING
LayerMapper
insteadsetDatabaseLayerMapper(DatabaseLayerMapper)
@Deprecated void setCreateEntities(boolean enable)
setIgnoreEntities(boolean)
enable
- true
, to import and update entities.void setIgnoreEntities(boolean ignore)
ignore
- true
, to ignore entities.@Deprecated void setDatabaseLayerMapper(@NotNull ImportOperation.DatabaseLayerMapper mapper)
setLayerMapper(LayerMapper)
insteadmapper
- The mapper providing the relevant information.IDENTITY_LAYER_MAPPING
,
ImportOperation.MapDatabaseLayerMapper.from(Map)
void setLayerMapper(@NotNull LayerMapper layerMapper)
Serializable
.layerMapper
- The mapper providing the relevant information.void setImportFilter(@NotNull Filter<ImportElementInfo> filter)
perform(FileSystem)
. Only elements passing the filter will be added for
import. Children of passing elements will always be imported as well.filter
- The filter to be passed.void setStepsListener(@NotNull StepsListener listener)
listener
- The listener to be set.void setImportScheduleEntryActiveState(boolean importScheduleEntryActiveState)
active state
of a ScheduleEntry
during the import (default = false
).schedule entries
will be imported as inactive entries.importScheduleEntryActiveState
- whether to import the active state or not (default = false
)void setRevisionComment(@NotNull String comment)
during the update
.comment
- Revision comment, should not contain line breaks.ImportOperation.Result perform(@NotNull FileSystem<?> fileSystem) throws IOException, LockException, ElementDeletedException, ElementMovedException, SyncOperationException
file system
. Exported elements from the file system will be imported as new elements.
Exported elements corresponding to elements, which already exist in the project, will be updated.fileSystem
- The file system to export to.IOException
- if any access to the file system fails.LockException
- if any element
is already locked by another user during the
import.ElementDeletedException
- if an element
has been expected to exist but is deleted on the
server side.ElementMovedException
- if an element
has been expected to exist at a certain path but
has been moved to a different path on the server side.SyncOperationException
- if any unhandled RuntimeException is thrown during the import.Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210