lumis.portal.file
Interface IFileDao

All Known Implementing Classes:

FileDaoJdbc

public interface IFileDao

Interface for file persistance

Since:

4.0.0

Method Summary

void	add(FileConfig fileConfig, ITransaction transaction) Add the file.
void	delete(java.lang.String fileId, ITransaction transaction) Delete the file.
FileConfig	findByFullPath(java.lang.String fullPath, ITransaction transaction) Find the file by the full path.
FileConfig	get(java.lang.String fileId, ITransaction transaction) Get the file.
java.lang.String	getIdByItemInfo(java.lang.String itemId, java.lang.String serviceInstanceId, java.lang.String sourceId, java.lang.String fieldId, ITransaction transaction) Get the fileId refered by a content with the given ids.
java.util.Collection<java.lang.String>	getIdsByFilesId(java.lang.String filesId, ITransaction transaction) Return the file ids that belongs to the files with the given id.
java.util.Collection<java.lang.String>	getIdsByFilesIdAndType(java.lang.String filesId, int type, ITransaction transaction) Return the file ids that belongs to the files with the given id and with the given type.
java.util.Collection<java.lang.String>	getIdsByServiceInstanceId(java.lang.String serviceInstanceId, ITransaction transaction) Return the file ids that belongs to the specified service instance.
int	getNumberOfServiceInstanceFiles(java.lang.String serviceInstanceId, ITransaction transaction) Returns the number of files for a service instance.
void	update(FileConfig fileConfig, ITransaction transaction) Updates the file's information.

Method Detail

add

void add(FileConfig fileConfig,
         ITransaction transaction)
         throws PortalException

Add the file.

Parameters:

fileConfig -

transaction -

Throws:

PortalException

get

FileConfig get(java.lang.String fileId,
               ITransaction transaction)
               throws PortalException

Get the file.

Parameters:

fileId -

transaction -

Returns:

Throws:

DaoException

PortalException

findByFullPath

FileConfig findByFullPath(java.lang.String fullPath,
                          ITransaction transaction)
                          throws PortalException

Find the file by the full path.

Parameters:

fullPath - the full path.

transaction - the transaction to be used.

Returns:

an instance of FileConfig.

Throws:

PortalException - if a database error occur.

Since:

6.0.0

delete

void delete(java.lang.String fileId,
            ITransaction transaction)
            throws PortalException

Delete the file.

Parameters:

fileId -

transaction -

Throws:

DaoException

PortalException

update

void update(FileConfig fileConfig,
            ITransaction transaction)
            throws PortalException

Updates the file's information.

Parameters:

fileConfig -

transaction -

Throws:

PortalException

getIdsByFilesId

java.util.Collection<java.lang.String> getIdsByFilesId(java.lang.String filesId,
                                                       ITransaction transaction)
                                                       throws PortalException

Return the file ids that belongs to the files with the given id.

Parameters:

filesId - the id of the files.

transaction - the transaction for persistence access.

Returns:

the file ids.

Throws:

PortalException

getIdsByServiceInstanceId

java.util.Collection<java.lang.String> getIdsByServiceInstanceId(java.lang.String serviceInstanceId,
                                                                 ITransaction transaction)
                                                                 throws PortalException

Return the file ids that belongs to the specified service instance.

Parameters:

serviceInstanceId - the service instance's id.

transaction - the transaction for persistence access.

Returns:

the file ids.

Throws:

PortalException

getIdsByFilesIdAndType

java.util.Collection<java.lang.String> getIdsByFilesIdAndType(java.lang.String filesId,
                                                              int type,
                                                              ITransaction transaction)
                                                              throws PortalException

Return the file ids that belongs to the files with the given id and with the given type.

Parameters:

filesId - the id of the files.

type - the type the returned files must have. The type value must be one of the TYPE constants available in FileConfig.

transaction - the transaction for persistence access.

Returns:

the file ids.

Throws:

PortalException

getIdByItemInfo

java.lang.String getIdByItemInfo(java.lang.String itemId,
                                 java.lang.String serviceInstanceId,
                                 java.lang.String sourceId,
                                 java.lang.String fieldId,
                                 ITransaction transaction)
                                 throws PortalException

Get the fileId refered by a content with the given ids.

Throws:

PortalException

getNumberOfServiceInstanceFiles

int getNumberOfServiceInstanceFiles(java.lang.String serviceInstanceId,
                                    ITransaction transaction)
                                    throws PortalException

Returns the number of files for a service instance.

Parameters:

serviceInstanceId - the service instance identifier.

transaction - the transaction for persistence access.

Returns:

the number of files for the specified service instance.

Throws:

PortalException

Since:

4.2.0