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 document library folder local service. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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, com.liferay.portlet.documentlibrary.service.base.DLFolderLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFolderLocalServiceImpl

Constructor Summary

DLFolderLocalServiceUtil()

Method Summary

static void	addDLFileEntryTypeDLFolder(long fileEntryTypeId, DLFolder dlFolder)
static void	addDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
static void	addDLFileEntryTypeDLFolders(long fileEntryTypeId, List<DLFolder> DLFolders)
static void	addDLFileEntryTypeDLFolders(long fileEntryTypeId, long[] folderIds)
static DLFolder	addDLFolder(DLFolder dlFolder) Adds the document library folder to the database.
static DLFolder	addFolder(long userId, long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext)
static void	clearDLFileEntryTypeDLFolders(long fileEntryTypeId)
static DLFolder	createDLFolder(long folderId) Creates a new document library folder with the primary key.
static void	deleteAll(long groupId)
static void	deleteDLFileEntryTypeDLFolder(long fileEntryTypeId, DLFolder dlFolder)
static void	deleteDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
static void	deleteDLFileEntryTypeDLFolders(long fileEntryTypeId, List<DLFolder> DLFolders)
static void	deleteDLFileEntryTypeDLFolders(long fileEntryTypeId, long[] folderIds)
static DLFolder	deleteDLFolder(DLFolder dlFolder) Deletes the document library folder from the database.
static DLFolder	deleteDLFolder(long folderId) Deletes the document library folder with the primary key from the database.
static void	deleteFolder(long folderId)
static DynamicQuery	dynamicQuery()
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) Returns the number of rows that match the dynamic query.
static DLFolder	fetchDLFolder(long folderId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<DLFolder>	getCompanyFolders(long companyId, int start, int end)
static int	getCompanyFoldersCount(long companyId)
static List<DLFolder>	getDLFileEntryTypeDLFolders(long fileEntryTypeId)
static List<DLFolder>	getDLFileEntryTypeDLFolders(long fileEntryTypeId, int start, int end)
static List<DLFolder>	getDLFileEntryTypeDLFolders(long fileEntryTypeId, int start, int end, OrderByComparator orderByComparator)
static int	getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId)
static DLFolder	getDLFolder(long folderId) Returns the document library folder with the primary key.
static DLFolder	getDLFolderByUuidAndGroupId(String uuid, long groupId) Returns the document library folder with the UUID in the group.
static List<DLFolder>	getDLFolders(int start, int end) Returns a range of all the document library folders.
static int	getDLFoldersCount() Returns the number of document library folders.
static List<Object>	getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
static int	getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
static DLFolder	getFolder(long folderId)
static DLFolder	getFolder(long groupId, long parentFolderId, String name)
static long	getFolderId(long companyId, long folderId)
static List<DLFolder>	getFolders(long groupId, long parentFolderId)
static List<DLFolder>	getFolders(long groupId, long parentFolderId, boolean includeMountfolders)
static List<DLFolder>	getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int start, int end, OrderByComparator obc)
static List<DLFolder>	getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator obc)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator obc)
static List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator obc)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, boolean includeMountFolders)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
static int	getFoldersCount(long groupId, long parentFolderId)
static int	getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders)
static int	getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
static DLFolder	getMountFolder(long repositoryId)
static List<DLFolder>	getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator obc)
static int	getMountFoldersCount(long groupId, long parentFolderId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLFolderLocalService	getService()
static void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
static boolean	hasDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
static boolean	hasDLFileEntryTypeDLFolders(long fileEntryTypeId)
static DLFolder	moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
static void	setDLFileEntryTypeDLFolders(long fileEntryTypeId, long[] folderIds)
void	setService(DLFolderLocalService service) Deprecated.
static DLFolder	updateDLFolder(DLFolder dlFolder) Updates the document library folder in the database or adds it if it does not yet exist.
static DLFolder	updateDLFolder(DLFolder dlFolder, boolean merge) Updates the document library folder in the database or adds it if it does not yet exist.
static DLFolder	updateFolder(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
static DLFolder	updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
static DLFolder	updateFolderAndFileEntryTypes(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
static void	updateLastPostDate(long folderId, Date lastPostDate) Deprecated.

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 document library folder to the database. Also notifies the appropriate model listeners.

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was added

Throws:

SystemException - if a system exception occurred

createDLFolder

public static DLFolder createDLFolder(long folderId)

Creates a new document library folder with the primary key. Does not add the document library folder to the database.

Parameters:

folderId - the primary key for the new document library folder

Returns:

the new document library folder

deleteDLFolder

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

Deletes the document library folder with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

folderId - the primary key of the document library folder

Returns:

the document library folder that was removed

Throws:

PortalException - if a document library folder with the primary key could not be found

SystemException - if a system exception occurred

deleteDLFolder

public static DLFolder deleteDLFolder(DLFolder dlFolder)
                               throws SystemException

Deletes the document library folder from the database. Also notifies the appropriate model listeners.

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

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

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

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (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

start - the lower bound of the range of model instances

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDLFolder

public static DLFolder fetchDLFolder(long folderId)
                              throws SystemException

Throws:

SystemException

getDLFolder

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

Returns the document library folder with the primary key.

Parameters:

folderId - the primary key of the document library folder

Returns:

the document library folder

Throws:

PortalException - if a document library folder with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getDLFolderByUuidAndGroupId

public static DLFolder getDLFolderByUuidAndGroupId(String uuid,
                                                   long groupId)
                                            throws PortalException,
                                                   SystemException

Returns the document library folder with the UUID in the group.

Parameters:

uuid - the UUID of document library folder

groupId - the group id of the document library folder

Returns:

the document library folder

Throws:

PortalException - if a document library folder with the UUID in the group could not be found

SystemException - if a system exception occurred

getDLFolders

public static List<DLFolder> getDLFolders(int start,
                                          int end)
                                   throws SystemException

Returns a range of all the document library 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 document library folders

end - the upper bound of the range of document library folders (not inclusive)

Returns:

the range of document library folders

Throws:

SystemException - if a system exception occurred

getDLFoldersCount

public static int getDLFoldersCount()
                             throws SystemException

Returns the number of document library folders.

Returns:

the number of document library folders

Throws:

SystemException - if a system exception occurred

updateDLFolder

public static DLFolder updateDLFolder(DLFolder dlFolder)
                               throws SystemException

Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was updated

Throws:

SystemException - if a system exception occurred

updateDLFolder

public static DLFolder updateDLFolder(DLFolder dlFolder,
                                      boolean merge)
                               throws SystemException

Updates the document library folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

dlFolder - the document library folder

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

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDLFolder

public static void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                              long folderId)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDLFolder

public static void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                              DLFolder dlFolder)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDLFolders

public static void addDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                               long[] folderIds)
                                        throws SystemException

Throws:

SystemException - if a system exception occurred

addDLFileEntryTypeDLFolders

public static void addDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                               List<DLFolder> DLFolders)
                                        throws SystemException

Throws:

SystemException - if a system exception occurred

clearDLFileEntryTypeDLFolders

public static void clearDLFileEntryTypeDLFolders(long fileEntryTypeId)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDLFolder

public static void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                 long folderId)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDLFolder

public static void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                 DLFolder dlFolder)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDLFolders

public static void deleteDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                  long[] folderIds)
                                           throws SystemException

Throws:

SystemException - if a system exception occurred

deleteDLFileEntryTypeDLFolders

public static void deleteDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                  List<DLFolder> DLFolders)
                                           throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDLFolders

public static List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId)
                                                  throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDLFolders

public static List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                         int start,
                                                         int end)
                                                  throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDLFolders

public static List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                         int start,
                                                         int end,
                                                         OrderByComparator orderByComparator)
                                                  throws SystemException

Throws:

SystemException - if a system exception occurred

getDLFileEntryTypeDLFoldersCount

public static int getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId)
                                            throws SystemException

Throws:

SystemException - if a system exception occurred

hasDLFileEntryTypeDLFolder

public static boolean hasDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                 long folderId)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

hasDLFileEntryTypeDLFolders

public static boolean hasDLFileEntryTypeDLFolders(long fileEntryTypeId)
                                           throws SystemException

Throws:

SystemException - if a system exception occurred

setDLFileEntryTypeDLFolders

public static void setDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                               long[] folderIds)
                                        throws SystemException

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFolder

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

Throws:

PortalException

SystemException

deleteAll

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

Throws:

PortalException

SystemException

deleteFolder

public static void deleteFolder(long folderId)
                         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,
                                                          long folderId,
                                                          int status,
                                                          int start,
                                                          int end)
                                                   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

getFolderId

public static long getFolderId(long companyId,
                               long folderId)
                        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,
                                        boolean includeMountfolders)
                                 throws SystemException

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcuts

public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    String[] mimeTypes,
                                                                    boolean includeMountFolders,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator obc)
                                                             throws SystemException

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

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

Throws:

SystemException

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                int status,
                                                                String[] mimeTypes,
                                                                boolean includeMountFolders)
                                                         throws SystemException

Throws:

SystemException

getFoldersCount

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

Throws:

SystemException

getFoldersCount

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

Throws:

SystemException

getFoldersFileEntriesCount

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

Throws:

SystemException

getMountFolder

public static DLFolder getMountFolder(long repositoryId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getMountFolders

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

Throws:

SystemException

getMountFoldersCount

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

Throws:

SystemException

getSubfolderIds

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

Throws:

SystemException

moveFolder

public static DLFolder moveFolder(long folderId,
                                  long parentFolderId,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateFolder

public static DLFolder updateFolder(long folderId,
                                    long parentFolderId,
                                    String name,
                                    String description,
                                    long defaultFileEntryTypeId,
                                    List<Long> fileEntryTypeIds,
                                    boolean overrideFileEntryTypes,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

updateFolder

public static DLFolder updateFolder(long folderId,
                                    String name,
                                    String description,
                                    long defaultFileEntryTypeId,
                                    List<Long> fileEntryTypeIds,
                                    boolean overrideFileEntryTypes,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

updateFolderAndFileEntryTypes

public static DLFolder updateFolderAndFileEntryTypes(long folderId,
                                                     long parentFolderId,
                                                     String name,
                                                     String description,
                                                     long defaultFileEntryTypeId,
                                                     List<Long> fileEntryTypeIds,
                                                     boolean overrideFileEntryTypes,
                                                     ServiceContext serviceContext)
                                              throws PortalException,
                                                     SystemException

Throws:

PortalException

SystemException

updateLastPostDate

public static void updateLastPostDate(long folderId,
                                      Date lastPostDate)
                               throws PortalException,
                                      SystemException

Deprecated.

Throws:

PortalException

SystemException

getService

public static DLFolderLocalService getService()

setService

public void setService(DLFolderLocalService service)

Deprecated.