com.crystaldecisions.sdk.occa.infostore
Interface IFile

All Known Subinterfaces:

ILocalFile, IRemoteFile

public interface IFile

This interface represents a local or remote file object.

This interface serves as a base interface for the "two-phase" file operations, in other words, the operation will not happen until the commit() method is invoked. The operation can also be cancelled by invoking the abort() method if the commit() method has not been invoked yet.

Method Summary

void	abort() Aborts the transaction.
void	commit() Commits the transaction.
java.lang.String	getName() Returns the name of the file object.
long	getSize() Returns the size of the file.

Method Detail

getName

public java.lang.String getName()

Returns the name of the file object.

Returns:

The name of the file object as a String.

getSize

public long getSize()
             throws SDKException

Returns the size of the file.

Returns:

A long that indicates file's size in kilobytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

commit

public void commit()
            throws SDKException

Commits the transaction.

Throws:

SDKException - This is thrown if the process is unsuccessful.

abort

public void abort()

Aborts the transaction.