com.liferay.portlet.documentlibrary.service
Class DLFolderLocalServiceUtil

java.lang.Object
  com.liferay.portlet.documentlibrary.service.DLFolderLocalServiceUtil

public class DLFolderLocalServiceUtil
extends Object

The utility for the d l folder local service. This utility wraps DLFolderLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to DLFolderLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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:

DLFolderLocalService, DLFolderLocalServiceBaseImpl, DLFolderLocalServiceImpl

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

Constructor Summary

DLFolderLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFolderLocalServiceUtil

public DLFolderLocalServiceUtil()

Method Detail

addDLFolder

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

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

Throws:

PortalException

SystemException

addFolderResources

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

Throws:

PortalException

SystemException

addFolderResources

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

Throws:

PortalException

SystemException

addFolderResources

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

Throws:

PortalException

SystemException

addFolderResources

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

Throws:

PortalException

SystemException

deleteFolder

public static void deleteFolder(DLFolder folder)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteFolder

public static void deleteFolder(long folderId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deleteFolders

public static void deleteFolders(long groupId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getCompanyFolders

public static List<DLFolder> getCompanyFolders(long companyId,
                                               int start,
                                               int end)
                                        throws SystemException

Throws:

SystemException

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)
                                  throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcuts

public static List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                          List<Long> folderIds,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcuts

public static List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                          long folderId,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      List<Long> folderIds,
                                                      int status)
                                               throws SystemException

Throws:

SystemException

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      long folderId,
                                                      int status)
                                               throws SystemException

Throws:

SystemException

getFolder

public static DLFolder getFolder(long folderId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getFolder

public static DLFolder getFolder(long groupId,
                                 long parentFolderId,
                                 String name)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getFolders

public static List<DLFolder> getFolders(long companyId)
                                 throws SystemException

Throws:

SystemException

getFolders

public static List<DLFolder> getFolders(long groupId,
                                        long parentFolderId)
                                 throws SystemException

Throws:

SystemException

getFolders

public static List<DLFolder> getFolders(long groupId,
                                        long parentFolderId,
                                        int start,
                                        int end)
                                 throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    List<Long> folderIds,
                                                                    int status,
                                                                    int start,
                                                                    int end)
                                                             throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    int start,
                                                                    int end)
                                                             throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                List<Long> folderIds,
                                                                int status)
                                                         throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                int status)
                                                         throws SystemException

Throws:

SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)
                           throws SystemException

Throws:

SystemException

getSubfolderIds

public static void getSubfolderIds(List<Long> folderIds,
                                   long groupId,
                                   long folderId)
                            throws SystemException

Throws:

SystemException

updateFolder

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

Throws:

PortalException

SystemException

getService

public static DLFolderLocalService getService()

setService

public void setService(DLFolderLocalService service)