com.ontimize.db

Interface FileManagementEntity

All Superinterfaces:

Remote

All Known Implementing Classes:

AdvancedQueryTableEntity, AdvancedTableEntity, CacheTableEntity, DatabaseMultiConnectionManagerEntity, DefaultNoticeDestinyEntity, DefaultTableEntity, LocaleEntity, ManagerMultilanguageEntity, NoticeEntity, PrintTemplateEntity, StandardAttachmentEntity, TableEntity, UserEntity

public interface FileManagementEntity
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelReceiving(String transferId, int sessionId) Cancels the file reception
boolean	deleteAttachmentFile(Hashtable keys, int sessionId)
boolean	finishReceiving(String transferId, int sessionId) Indicates that the transfer process is finished
BytesBlock	getBytes(String transferId, int offset, int lenght, int sessionId) Gets a BytesBlock with the bytes from offset and with the specified length.
String	getExtension(String transferId) Get the file extension.
long	getSize(String transferId) The file size is returned if it is known.
String	prepareToReceive(Hashtable keys, String fileName, String fileDescription, int sessionId)
String	prepareToReceive(Hashtable keys, String fileName, String originalFilePath, String fileDescription, int sessionId)
String	prepareToReceive(String column, Hashtable keys, int sessionId) Indicates the entity must prepare for receiving file content.
String	prepareToTransfer(Hashtable cv, int sessionId)
String	prepareToTransfer(String column, Hashtable keys, int sessionId) Indicates the entity must prepare for transferring file content.
void	putBytes(String transferId, BytesBlock bytesBlock, int sessionId)

Method Detail

getSize

long getSize(String transferId)
             throws Exception

The file size is returned if it is known. Return -1 when it is an unknown value. Before calls this method the method prepareToTransfer must be called

Parameters:

transferId -

Returns:

Throws:

Exception

getExtension

String getExtension(String transferId)
                    throws Exception

Get the file extension. If the file has not extension return null

Parameters:

transferId -

Returns:

Throws:

Exception

prepareToTransfer

String prepareToTransfer(String column,
                       Hashtable keys,
                       int sessionId)
                         throws Exception

Indicates the entity must prepare for transferring file content.

Parameters:

column -

keys -

sessionId -

Returns:

A random string identifying the transfer process. This identifier is used in the next requests for this file content

Throws:

Exception

prepareToReceive

String prepareToReceive(String column,
                      Hashtable keys,
                      int sessionId)
                        throws Exception

Indicates the entity must prepare for receiving file content.

Parameters:

column -

keys -

sessionId -

Returns:

A random string identifying the transfer process. This identifier is used in the next requests to receive the bytes blocks

Throws:

Exception

prepareToTransfer

String prepareToTransfer(Hashtable cv,
                       int sessionId)
                         throws Exception

Throws:

Exception

prepareToReceive

String prepareToReceive(Hashtable keys,
                      String fileName,
                      String fileDescription,
                      int sessionId)
                        throws Exception

Throws:

Exception

prepareToReceive

String prepareToReceive(Hashtable keys,
                      String fileName,
                      String originalFilePath,
                      String fileDescription,
                      int sessionId)
                        throws Exception

Throws:

Exception

getBytes

BytesBlock getBytes(String transferId,
                  int offset,
                  int lenght,
                  int sessionId)
                    throws Exception

Gets a BytesBlock with the bytes from offset and with the specified length. Return null if it is the end of the file. The prepareToTransfer method must be called previously to get the 'transferId' value.

Parameters:

transferId -

offset -

lenght -

sessionId -

Returns:

Throws:

Exception

putBytes

void putBytes(String transferId,
            BytesBlock bytesBlock,
            int sessionId)
              throws Exception

Throws:

Exception

finishReceiving

boolean finishReceiving(String transferId,
                      int sessionId)
                        throws Exception

Indicates that the transfer process is finished

Parameters:

transferId -

sessionId -

Returns:

Throws:

Exception

cancelReceiving

void cancelReceiving(String transferId,
                   int sessionId)
                     throws Exception

Cancels the file reception

Parameters:

transferId -

sessionId -

Throws:

Exception

deleteAttachmentFile

boolean deleteAttachmentFile(Hashtable keys,
                           int sessionId)
                             throws Exception

Throws:

Exception