IExport

public interface IExport

Author:: Jiri Banszel, POLARION SOFTWARE

Method Summary

Modifier and Type

Method

Description

IUser

getAuthor()

Returns author of the export, i.e.

String

getExportId()

Returns unique id of this export.

IExportCommand.IExportResult

getExportResult()

IJob

getJob()

Returns job of this export.

InputStream

getResult()

Returns result of the export in the form of input stream, or null if no result was produced by the exporter.

boolean

isFinished()

Returns true if the export job is finished or aborted.

boolean

isSuccessful()

Returns true if the export has finished without error.

Method Details
- getExportId
  
  String getExportId()
  
  Returns unique id of this export.
- isFinished
  
  boolean isFinished()
  
  Returns true if the export job is finished or aborted.
- isSuccessful
  
  boolean isSuccessful()
  
  Returns true if the export has finished without error.
  
  Throws:
  
  IllegalStateException - if job is not finished yet
- getResult
  
  InputStream getResult()
  
  Returns result of the export in the form of input stream, or null if no result was produced by the exporter.
  
  Throws:
  
  IllegalStateException - if job is not finished yet
- getExportResult
  
  IExportCommand.IExportResult getExportResult()
  
  Returns:
  
  exporter specific export result
  
  Since:
  
  3.5.1
- getAuthor
  
  IUser getAuthor()
  
  Returns author of the export, i.e. the user that started it.
- getJob
  
  IJob getJob()
  
  Returns job of this export.