com.businessobjects.sdk.biar
Interface IImport

All Superinterfaces:

ICancelable

public interface IImport
extends ICancelable

This interface represents a BIAR import Initially the import is inactive, but can be started by calling the IImport.run() method. An import must always be disposed, by calling IImport.dispose() when it will no longer be used, regardless of whether the import completed or not.

A running import may be cancelled, in which case the run method will abort by throwing a com.businessobjects.sdk.biar.exception.BIARException.

To run the import asynchronously, use AsyncImport.

See Also:

IObjectManager.importArchiveInteractively(String, IImportOptions)

Method Summary

void	dispose() Disposes of the import, releasing any resources it consumes.
boolean	isCompleted() Returns true if IImport.run() has been called and subsequently returned normally (i.e. the import was successful and was not cancelled).
IObjectManager	run() Runs the import.

Methods inherited from interface com.businessobjects.sdk.biar.ICancelable

cancel

Method Detail

isCompleted

boolean isCompleted()

Returns true if IImport.run() has been called and subsequently returned normally (i.e. the import was successful and was not cancelled). This method does not synchronize with the running import, so data races may occur.

Returns:

true if the import has been completed successfully.

dispose

void dispose()
             throws BIARException

Disposes of the import, releasing any resources it consumes. This method should always be called when this object will no longer be used.

Throws:

BIARException

run

IObjectManager run()
                   throws BIARException

Runs the import. The import remains running, or in-progress, until this method returns. After a normal return from this method, the import is said to be complete. The running import may be aborted by calling ICancelable.cancel(), in which case this method will throw a BIARException.

Returns:

the IObjectManager where the import's results can be found.

Throws:

BIARException - if an error occurs during import, or if the import is cancelled.