Interface ExportService
-
- All Known Implementing Classes:
DefaultExportService
public interface ExportService
Service for exporting data using impex extension.- Since:
- 4.0
- Spring Bean ID:
- exportService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ExportResult
exportData(ExportConfig config)
Exports platform data.ExportResult
exportData(ImpExResource script)
Exports platform data using given impex export script.ImpExValidationResult
validateExportScript(java.lang.String script, ImpExValidationModeEnum validationMode)
Validates export script.
-
-
-
Method Detail
-
exportData
ExportResult exportData(ImpExResource script)
Exports platform data using given impex export script. Default parameters are set as when creating an emptyExportConfig
, so execution will be synchronous for example. Returns a result object where exported data can be accessed from.- Parameters:
script
- export script- Returns:
- result of export
-
exportData
ExportResult exportData(ExportConfig config)
Exports platform data. The export is configured by given configuration object. Please pay attention for the defaults of parameters not explicitly configured. For example the export will be executed synchronous if not reconfigured. Returns a result object for accessing state of export and resulting data. If executed asynchronous the exported data can be accessed only ifExportResult.isFinished()
returns true.- Parameters:
config
- export configuration- Returns:
- result of export
-
validateExportScript
ImpExValidationResult validateExportScript(java.lang.String script, ImpExValidationModeEnum validationMode)
Validates export script.- Returns:
- result of script validation
-
-