com.liferay.portlet.documentlibrary.service
Interface DLFileEntryLocalService

All Known Implementing Classes:

DLFileEntryLocalServiceBaseImpl, DLFileEntryLocalServiceImpl, DLFileEntryLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryLocalService

The interface for the d l file entry local service.

Never modify or reference this interface directly. Always use DLFileEntryLocalServiceUtil to access the d l file entry local service. Add custom service methods to DLFileEntryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

DLFileEntryLocalServiceUtil, DLFileEntryLocalServiceBaseImpl, DLFileEntryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

DLFileEntry	addDLFileEntry(DLFileEntry dlFileEntry) Adds the d l file entry to the database.
DLFileEntry	addFileEntry(long userId, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, byte[] bytes, ServiceContext serviceContext)
DLFileEntry	addFileEntry(long userId, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, File file, ServiceContext serviceContext)
DLFileEntry	addFileEntry(long userId, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, InputStream is, long size, ServiceContext serviceContext)
void	addFileEntryResources(DLFileEntry fileEntry, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addFileEntryResources(DLFileEntry fileEntry, String[] communityPermissions, String[] guestPermissions)
void	addFileEntryResources(long fileEntryId, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addFileEntryResources(long fileEntryId, String[] communityPermissions, String[] guestPermissions)
DLFileEntry	addOrOverwriteFileEntry(long userId, long groupId, long folderId, String name, String sourceName, String title, String description, String changeLog, String extraSettings, File file, ServiceContext serviceContext)
DLFileEntry	createDLFileEntry(long fileEntryId) Creates a new d l file entry with the primary key.
void	deleteDLFileEntry(DLFileEntry dlFileEntry) Deletes the d l file entry from the database.
void	deleteDLFileEntry(long fileEntryId) Deletes the d l file entry with the primary key from the database.
void	deleteFileEntries(long groupId, long folderId)
void	deleteFileEntry(DLFileEntry fileEntry)
void	deleteFileEntry(long groupId, long folderId, String name)
void	deleteFileEntry(long groupId, long folderId, String name, String version)
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<DLFileEntry>	getCompanyFileEntries(long companyId, int start, int end)
List<DLFileEntry>	getCompanyFileEntries(long companyId, int start, int end, OrderByComparator obc)
int	getCompanyFileEntriesCount(long companyId)
List<DLFileEntry>	getDLFileEntries(int start, int end) Gets a range of all the d l file entries.
int	getDLFileEntriesCount() Gets the number of d l file entries.
DLFileEntry	getDLFileEntry(long fileEntryId) Gets the d l file entry with the primary key.
DLFileEntry	getDLFileEntryByUuidAndGroupId(String uuid, long groupId) Gets the d l file entry with the UUID and group id.
InputStream	getFileAsStream(long companyId, long userId, long groupId, long folderId, String name)
InputStream	getFileAsStream(long companyId, long userId, long groupId, long folderId, String name, String version)
List<DLFileEntry>	getFileEntries(long groupId, long folderId)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
int	getFileEntriesCount(long groupId, long folderId)
DLFileEntry	getFileEntry(long fileEntryId)
DLFileEntry	getFileEntry(long groupId, long folderId, String name)
DLFileEntry	getFileEntryByTitle(long groupId, long folderId, String title)
DLFileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId)
int	getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
List<DLFileEntry>	getGroupFileEntries(long groupId, int start, int end)
List<DLFileEntry>	getGroupFileEntries(long groupId, int start, int end, OrderByComparator obc)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, int start, int end)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator obc)
int	getGroupFileEntriesCount(long groupId)
int	getGroupFileEntriesCount(long groupId, long userId)
List<DLFileEntry>	getNoAssetFileEntries()
DLFileEntry	moveFileEntry(long userId, long groupId, long folderId, long newFolderId, String name, ServiceContext serviceContext)
void	updateAsset(long userId, DLFileEntry fileEntry, DLFileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames)
DLFileEntry	updateDLFileEntry(DLFileEntry dlFileEntry) Updates the d l file entry in the database.
DLFileEntry	updateDLFileEntry(DLFileEntry dlFileEntry, boolean merge) Updates the d l file entry in the database.
DLFileEntry	updateFileEntry(long userId, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, byte[] bytes, ServiceContext serviceContext)
DLFileEntry	updateFileEntry(long userId, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, File file, ServiceContext serviceContext)
DLFileEntry	updateFileEntry(long userId, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, InputStream is, long size, ServiceContext serviceContext)
DLFileEntry	updateStatus(long userId, long fileEntryId, int status, ServiceContext serviceContext)

Method Detail

addDLFileEntry

DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)
                           throws SystemException

Adds the d l file entry to the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to add

Returns:

the d l file entry that was added

Throws:

SystemException - if a system exception occurred

createDLFileEntry

DLFileEntry createDLFileEntry(long fileEntryId)

Creates a new d l file entry with the primary key. Does not add the d l file entry to the database.

Parameters:

fileEntryId - the primary key for the new d l file entry

Returns:

the new d l file entry

deleteDLFileEntry

void deleteDLFileEntry(long fileEntryId)
                       throws PortalException,
                              SystemException

Deletes the d l file entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fileEntryId - the primary key of the d l file entry to delete

Throws:

PortalException - if a d l file entry with the primary key could not be found

SystemException - if a system exception occurred

deleteDLFileEntry

void deleteDLFileEntry(DLFileEntry dlFileEntry)
                       throws SystemException

Deletes the d l file entry from the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getDLFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntry(long fileEntryId)
                           throws PortalException,
                                  SystemException

Gets the d l file entry with the primary key.

Parameters:

fileEntryId - the primary key of the d l file entry to get

Returns:

the d l file entry

Throws:

PortalException - if a d l file entry with the primary key could not be found

SystemException - if a system exception occurred

getDLFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid,
                                                                                    long groupId)
                                           throws PortalException,
                                                  SystemException

Gets the d l file entry with the UUID and group id.

Parameters:

uuid - the UUID of d l file entry to get

groupId - the group id of the d l file entry to get

Returns:

the d l file entry

Throws:

PortalException - if a d l file entry with the UUID and group id could not be found

SystemException - if a system exception occurred

getDLFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDLFileEntries(int start,
                                                                            int end)
                                   throws SystemException

Gets a range of all the d l file entries.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of d l file entries to return

end - the upper bound of the range of d l file entries to return (not inclusive)

Returns:

the range of d l file entries

Throws:

SystemException - if a system exception occurred

getDLFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileEntriesCount()
                          throws SystemException

Gets the number of d l file entries.

Returns:

the number of d l file entries

Throws:

SystemException - if a system exception occurred

updateDLFileEntry

DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
                              throws SystemException

Updates the d l file entry in the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to update

Returns:

the d l file entry that was updated

Throws:

SystemException - if a system exception occurred

updateDLFileEntry

DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry,
                              boolean merge)
                              throws SystemException

Updates the d l file entry in the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to update

merge - whether to merge the d l file entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the d l file entry that was updated

Throws:

SystemException - if a system exception occurred

addFileEntry

DLFileEntry addFileEntry(long userId,
                         long groupId,
                         long folderId,
                         String name,
                         String title,
                         String description,
                         String changeLog,
                         String extraSettings,
                         byte[] bytes,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

addFileEntry

DLFileEntry addFileEntry(long userId,
                         long groupId,
                         long folderId,
                         String name,
                         String title,
                         String description,
                         String changeLog,
                         String extraSettings,
                         File file,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

addFileEntry

DLFileEntry addFileEntry(long userId,
                         long groupId,
                         long folderId,
                         String name,
                         String title,
                         String description,
                         String changeLog,
                         String extraSettings,
                         InputStream is,
                         long size,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

addFileEntryResources

void addFileEntryResources(DLFileEntry fileEntry,
                           boolean addCommunityPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

addFileEntryResources

void addFileEntryResources(DLFileEntry fileEntry,
                           String[] communityPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

addFileEntryResources

void addFileEntryResources(long fileEntryId,
                           boolean addCommunityPermissions,
                           boolean addGuestPermissions)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

addFileEntryResources

void addFileEntryResources(long fileEntryId,
                           String[] communityPermissions,
                           String[] guestPermissions)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

addOrOverwriteFileEntry

DLFileEntry addOrOverwriteFileEntry(long userId,
                                    long groupId,
                                    long folderId,
                                    String name,
                                    String sourceName,
                                    String title,
                                    String description,
                                    String changeLog,
                                    String extraSettings,
                                    File file,
                                    ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteFileEntries

void deleteFileEntries(long groupId,
                       long folderId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deleteFileEntry

void deleteFileEntry(DLFileEntry fileEntry)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFileEntry

void deleteFileEntry(long groupId,
                     long folderId,
                     String name)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteFileEntry

void deleteFileEntry(long groupId,
                     long folderId,
                     String name,
                     String version)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getCompanyFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getCompanyFileEntries(long companyId,
                                                                                 int start,
                                                                                 int end)
                                        throws SystemException

Throws:

SystemException

getCompanyFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getCompanyFileEntries(long companyId,
                                                                                 int start,
                                                                                 int end,
                                                                                 OrderByComparator obc)
                                        throws SystemException

Throws:

SystemException

getCompanyFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyFileEntriesCount(long companyId)
                               throws SystemException

Throws:

SystemException

getFileAsStream

InputStream getFileAsStream(long companyId,
                            long userId,
                            long groupId,
                            long folderId,
                            String name)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFileAsStream

InputStream getFileAsStream(long companyId,
                            long userId,
                            long groupId,
                            long folderId,
                            String name,
                            String version)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId)
                                 throws SystemException

Throws:

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int start,
                                                                          int end)
                                 throws SystemException

Throws:

SystemException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws SystemException

Throws:

SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId)
                        throws SystemException

Throws:

SystemException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long groupId,
                                                                  long folderId,
                                                                  String name)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getFileEntryByTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByTitle(long groupId,
                                                                         long folderId,
                                                                         String title)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

getFoldersFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersFileEntriesCount(long groupId,
                                                                        List<Long> folderIds,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException

Throws:

SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator obc)
                                      throws SystemException

Throws:

SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException

Throws:

SystemException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator obc)
                                      throws SystemException

Throws:

SystemException

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId)
                             throws SystemException

Throws:

SystemException

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId)
                             throws SystemException

Throws:

SystemException

getNoAssetFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getNoAssetFileEntries()
                                        throws SystemException

Throws:

SystemException

moveFileEntry

DLFileEntry moveFileEntry(long userId,
                          long groupId,
                          long folderId,
                          long newFolderId,
                          String name,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

updateAsset

void updateAsset(long userId,
                 DLFileEntry fileEntry,
                 DLFileVersion fileVersion,
                 long[] assetCategoryIds,
                 String[] assetTagNames)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

updateFileEntry

DLFileEntry updateFileEntry(long userId,
                            long groupId,
                            long folderId,
                            String name,
                            String sourceFileName,
                            String title,
                            String description,
                            String changeLog,
                            boolean majorVersion,
                            String extraSettings,
                            byte[] bytes,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateFileEntry

DLFileEntry updateFileEntry(long userId,
                            long groupId,
                            long folderId,
                            String name,
                            String sourceFileName,
                            String title,
                            String description,
                            String changeLog,
                            boolean majorVersion,
                            String extraSettings,
                            File file,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateFileEntry

DLFileEntry updateFileEntry(long userId,
                            long groupId,
                            long folderId,
                            String name,
                            String sourceFileName,
                            String title,
                            String description,
                            String changeLog,
                            boolean majorVersion,
                            String extraSettings,
                            InputStream is,
                            long size,
                            ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateStatus

DLFileEntry updateStatus(long userId,
                         long fileEntryId,
                         int status,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException