public interface ExportOperation
file system
. Request this operation via OperationAgent
: OperationAgent.getOperation(ExportOperation.TYPE)
. To get a file system
use FileSystemsAgent
.OperationAgent
,
FileSystemsAgent
Modifier and Type | Interface and Description |
---|---|
static interface |
ExportOperation.ChannelsProviderOptions
Options for configuring the export of an added
channels provider . |
static interface |
ExportOperation.Result
Container providing access to the result of the export operation.
|
static interface |
ExportOperation.SchemaOptions
Options for configuring the export of an added
schema . |
Modifier and Type | Field and Description |
---|---|
static OperationType<ExportOperation> |
TYPE
Operation providing means to export store elements to files in a
file system . |
Modifier and Type | Method and Description |
---|---|
ExportOperation.ChannelsProviderOptions |
addChannelProvider(ChannelSourceProvider element)
Add a channels providing element for export.
|
void |
addElement(IDProvider element)
Generically adds a FirstSpirit element to be exported.
|
ExportOperation.SchemaOptions |
addSchema(Schema element)
Add a schema element for export.
|
PropertiesTransportOptions |
configurePropertiesExport()
Request a options object to configure global properties export.
|
ExportOperation.Result |
perform(FileSystem<?> fileSystem)
Perform the export on the given
file system . |
void |
setDeleteObsoleteFiles(boolean enable)
Defines to delete obsoletes files from the file system.
|
void |
setExportChildElements(boolean enable)
Defines to export child elements of elements added to this operation.
|
void |
setExportLostAndFound(boolean enable)
Defines whether the contents in lost and found folders should be exported or not.
|
void |
setExportParentElements(boolean enable)
Defines to export parent elements of elements added to this operation.
|
void |
setExportRelease(boolean enable)
Defines to operate on release or the latest revision of FirstSpirit elements or entities.
|
void |
setExportReleaseEntities(boolean enable)
Deprecated.
since 5.2.313, replaced by
setExportRelease(boolean) |
void |
setStepsListener(StepsListener listener)
Sets the listener that gets informed on steps being started.
|
static final OperationType<ExportOperation> TYPE
file system
.void addElement(@NotNull IDProvider element) throws IllegalArgumentException
setExportRelease(boolean)
to define whether the release
or the current
version ofgiven element should be exported during perform(FileSystem)
element
- The element to be added.IllegalArgumentException
- if the given element
has been deletedsetExportRelease(boolean)
ExportOperation.SchemaOptions addSchema(@NotNull Schema element) throws IllegalArgumentException
options object
.element
- The schema element to be added.IllegalArgumentException
- if the given schema
has been deletedExportOperation.ChannelsProviderOptions addChannelProvider(@NotNull ChannelSourceProvider element) throws IllegalArgumentException
options object
.element
- The channels providing element.IllegalArgumentException
- if the given ChannelSourceProvider
has been deleted@Deprecated void setExportReleaseEntities(boolean enable)
setExportRelease(boolean)
enable
- true
, to operate on released elements.void setExportRelease(boolean enable)
enable
- true
, to operate on released elements or entities.void setExportChildElements(boolean enable)
true
. Note that entities are not children of a schema. This option is enabled by default.enable
- true
, to export recursively.void setExportParentElements(boolean enable)
enable
- true
, to export parents.void setDeleteObsoleteFiles(boolean enable)
enable
- true
, to delete obsolete files.void setExportLostAndFound(boolean enable)
false
.enable
- true
, to export the contents in lost and found folders.void setStepsListener(@NotNull StepsListener listener)
listener
- The listener to be set.PropertiesTransportOptions configurePropertiesExport() throws SecurityException
project admins
. Will throw an security exception otherwise.SecurityException
- if current user is no project admin of the belonging projectExportOperation.Result perform(@NotNull FileSystem<?> fileSystem) throws IOException, SyncOperationException
fileSystem
- The file system to export to.IOException
- if any access to the file system fails.SyncOperationException
- if any unhandled RuntimeException is thrown during the export.FileSystemsAgent
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210