com.liferay.portlet.documentlibrary.service
Interface DLFolderLocalService

All Known Implementing Classes:

DLFolderLocalServiceBaseImpl, DLFolderLocalServiceImpl, DLFolderLocalServiceWrapper

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

The interface for the d l folder local service.

Never modify or reference this interface directly. Always use DLFolderLocalServiceUtil to access the d l folder local service. Add custom service methods to DLFolderLocalServiceImpl 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:

DLFolderLocalServiceUtil, DLFolderLocalServiceBaseImpl, DLFolderLocalServiceImpl

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

Method Summary

DLFolder	addDLFolder(DLFolder dlFolder) Adds the d l folder to the database.
DLFolder	addFolder(long userId, long groupId, long parentFolderId, String name, String description, ServiceContext serviceContext)
void	addFolderResources(DLFolder folder, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addFolderResources(DLFolder folder, String[] communityPermissions, String[] guestPermissions)
void	addFolderResources(long folderId, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addFolderResources(long folderId, String[] communityPermissions, String[] guestPermissions)
DLFolder	createDLFolder(long folderId) Creates a new d l folder with the primary key.
void	deleteDLFolder(DLFolder dlFolder) Deletes the d l folder from the database.
void	deleteDLFolder(long folderId) Deletes the d l folder with the primary key from the database.
void	deleteFolder(DLFolder folder)
void	deleteFolder(long folderId)
void	deleteFolders(long groupId)
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<DLFolder>	getCompanyFolders(long companyId, int start, int end)
int	getCompanyFoldersCount(long companyId)
DLFolder	getDLFolder(long folderId) Gets the d l folder with the primary key.
DLFolder	getDLFolderByUuidAndGroupId(String uuid, long groupId) Gets the d l folder with the UUID and group id.
List<DLFolder>	getDLFolders(int start, int end) Gets a range of all the d l folders.
int	getDLFoldersCount() Gets the number of d l folders.
List<Object>	getFileEntriesAndFileShortcuts(long groupId, List<Long> folderIds, int status, int start, int end)
List<Object>	getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
int	getFileEntriesAndFileShortcutsCount(long groupId, List<Long> folderIds, int status)
int	getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
DLFolder	getFolder(long folderId)
DLFolder	getFolder(long groupId, long parentFolderId, String name)
List<DLFolder>	getFolders(long companyId)
List<DLFolder>	getFolders(long groupId, long parentFolderId)
List<DLFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, List<Long> folderIds, int status, int start, int end)
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, List<Long> folderIds, int status)
int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
int	getFoldersCount(long groupId, long parentFolderId)
void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
DLFolder	updateDLFolder(DLFolder dlFolder) Updates the d l folder in the database.
DLFolder	updateDLFolder(DLFolder dlFolder, boolean merge) Updates the d l folder in the database.
DLFolder	updateFolder(long folderId, long parentFolderId, String name, String description, ServiceContext serviceContext)

Method Detail

addDLFolder

DLFolder addDLFolder(DLFolder dlFolder)
                     throws SystemException

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

Parameters:

dlFolder - the d l folder to add

Returns:

the d l folder that was added

Throws:

SystemException - if a system exception occurred

createDLFolder

DLFolder createDLFolder(long folderId)

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

Parameters:

folderId - the primary key for the new d l folder

Returns:

the new d l folder

deleteDLFolder

void deleteDLFolder(long folderId)
                    throws PortalException,
                           SystemException

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

Parameters:

folderId - the primary key of the d l folder to delete

Throws:

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

SystemException - if a system exception occurred

deleteDLFolder

void deleteDLFolder(DLFolder dlFolder)
                    throws SystemException

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

Parameters:

dlFolder - the d l folder 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

getDLFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getDLFolder(long folderId)
                     throws PortalException,
                            SystemException

Gets the d l folder with the primary key.

Parameters:

folderId - the primary key of the d l folder to get

Returns:

the d l folder

Throws:

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

SystemException - if a system exception occurred

getDLFolderByUuidAndGroupId

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

Gets the d l folder with the UUID and group id.

Parameters:

uuid - the UUID of d l folder to get

groupId - the group id of the d l folder to get

Returns:

the d l folder

Throws:

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

SystemException - if a system exception occurred

getDLFolders

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

Gets a range of all the d l folders.

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 folders to return

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

Returns:

the range of d l folders

Throws:

SystemException - if a system exception occurred

getDLFoldersCount

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

Gets the number of d l folders.

Returns:

the number of d l folders

Throws:

SystemException - if a system exception occurred

updateDLFolder

DLFolder updateDLFolder(DLFolder dlFolder)
                        throws SystemException

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

Parameters:

dlFolder - the d l folder to update

Returns:

the d l folder that was updated

Throws:

SystemException - if a system exception occurred

updateDLFolder

DLFolder updateDLFolder(DLFolder dlFolder,
                        boolean merge)
                        throws SystemException

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

Parameters:

dlFolder - the d l folder to update

merge - whether to merge the d l folder 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 folder that was updated

Throws:

SystemException - if a system exception occurred

addFolder

DLFolder addFolder(long userId,
                   long groupId,
                   long parentFolderId,
                   String name,
                   String description,
                   ServiceContext serviceContext)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(DLFolder folder,
                        boolean addCommunityPermissions,
                        boolean addGuestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(DLFolder folder,
                        String[] communityPermissions,
                        String[] guestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(long folderId,
                        boolean addCommunityPermissions,
                        boolean addGuestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addFolderResources

void addFolderResources(long folderId,
                        String[] communityPermissions,
                        String[] guestPermissions)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteFolder

void deleteFolder(DLFolder folder)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

deleteFolder

void deleteFolder(long folderId)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

deleteFolders

void deleteFolders(long groupId)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getCompanyFolders

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

Throws:

SystemException

getCompanyFoldersCount

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

Throws:

SystemException

getFileEntriesAndFileShortcuts

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

Throws:

SystemException

getFileEntriesAndFileShortcuts

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

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

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

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

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

Throws:

SystemException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long folderId)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long groupId,
                                                            long parentFolderId,
                                                            String name)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long companyId)
                          throws SystemException

Throws:

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId)
                          throws SystemException

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

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

Throws:

SystemException

getFoldersCount

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

Throws:

SystemException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                              long groupId,
                                                              long folderId)
                     throws SystemException

Throws:

SystemException

updateFolder

DLFolder updateFolder(long folderId,
                      long parentFolderId,
                      String name,
                      String description,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException