de.hybris.platform.servicelayer.impex

Interface ExportResult

All Known Implementing Classes:

ExportCronJobResult

public interface ExportResult

Represents a result of an export. Provides methods for getting the state and result of the export as well as methods for getting the exported data.

Since:

4.0

Method Summary

Modifier and Type	Method and Description
ExportModel	getExport() Gets an export object referencing exported data anad media.
ImpExMediaModel	getExportedData() Gets the media containing the exported csv files (backed by a zip-archive).
ImpExMediaModel	getExportedMedia() Gets the media containing the exported media files (backed by a zip-archive).
boolean	isError() Gets whether the export was not successfully.
boolean	isFinished() Gets whether the export is not running anymore.
boolean	isRunning() Gets whether the export is still running.
boolean	isSuccessful() Gets whether the export was successfully.

Method Detail

isSuccessful

boolean isSuccessful()

Gets whether the export was successfully.

Returns:

true if export was successfully

Throws:

java.lang.IllegalStateException - in case export is still running.

isError

boolean isError()

Gets whether the export was not successfully.

Returns:

true if export was not successfully

Throws:

java.lang.IllegalStateException - in case export is still running.

isRunning

boolean isRunning()

Gets whether the export is still running.

Returns:

true if export is still running

isFinished

boolean isFinished()

Gets whether the export is not running anymore.

Returns:

true if export is not running

getExportedData

ImpExMediaModel getExportedData()

Gets the media containing the exported csv files (backed by a zip-archive).

Returns:

exported data

getExportedMedia

ImpExMediaModel getExportedMedia()

Gets the media containing the exported media files (backed by a zip-archive).

Returns:

exported media

getExport

ExportModel getExport()

Gets an export object referencing exported data anad media.

Returns:

export result model