Interface IDocumentDownloader

All Superinterfaces:

IDisposable, IEntity

All Known Subinterfaces:

IEntityUploadResultDownloader

public interface IDocumentDownloader
extends IEntity

Used to download a document from the Altitude uCI Server.

Method Summary

Modifier and Type	Method	Description
int	getId()	Identifier of the DocumentDownloader.
byte[]	getNextBlock()	Returns the next block of the document to download.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

getId

int getId()
   throws Exception,
altitude.integrationServer.exceptions.ISException

Identifier of the DocumentDownloader.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNextBlock

byte[] getNextBlock()
             throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the next block of the document to download. This method can be invoked several times to download the complete document, until it returns null.

Returns:

The block of the document encoded in UTF-8, or null if all blocks have been downloaded.

Throws:

Exception

altitude.integrationServer.exceptions.ISException