com.crystaldecisions.sdk.occa.infostore
Interface IStreamingDownloadFile

public interface IStreamingDownloadFile

This object enables you to use streaming when transferring files from SAP BusinessObjects Enterprise.

Method Summary

void	closeFile() Closes the file and release the resources.
long	getSize()
boolean	hasNextChunk() Returns a boolean indicating whether the file has any remaining chunks to transfers.
byte[]	nextChunk() Returns the next chunk of the file as a byte array.
void	openFile() Open the file for streaming.
long	skip(long numBytes)

Method Detail

openFile

void openFile()
              throws SDKException

Open the file for streaming.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasNextChunk

boolean hasNextChunk()
                     throws SDKException

Returns a boolean indicating whether the file has any remaining chunks to transfers.

Returns:

A boolean indicating whether the file has any remaining chunks to transfers.

Throws:

SDKException - This is thrown if the process is unsuccessful.

nextChunk

byte[] nextChunk()
                 throws SDKException

Returns the next chunk of the file as a byte array.

Returns:

A byte[] array containing a chunk of the file's data.

Throws:

SDKException - This is thrown if the process is unsuccessful.

closeFile

void closeFile()
               throws SDKException

Closes the file and release the resources.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getSize

long getSize()
             throws SDKException

Throws:

SDKException

skip

long skip(long numBytes)
          throws SDKException

Throws:

SDKException