com.liferay.document.library.kernel.service

Class DLFolderLocalServiceUtil

java.lang.Object

com.liferay.document.library.kernel.service.DLFolderLocalServiceUtil

public class DLFolderLocalServiceUtil
extends java.lang.Object

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

Author:

Brian Wing Shun Chan

See Also:

DLFolderLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
DLFolderLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addDLFileEntryTypeDLFolder(long fileEntryTypeId, DLFolder dlFolder)
static void	addDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
static void	addDLFileEntryTypeDLFolders(long fileEntryTypeId, java.util.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, java.lang.String name, java.lang.String description, boolean hidden, ServiceContext serviceContext)
static void	clearDLFileEntryTypeDLFolders(long fileEntryTypeId)
static DLFolder	createDLFolder(long folderId) Creates a new document library folder with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteAllByGroup(long groupId)
static void	deleteAllByRepository(long repositoryId)
static void	deleteDLFileEntryTypeDLFolder(long fileEntryTypeId, DLFolder dlFolder)
static void	deleteDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
static void	deleteDLFileEntryTypeDLFolders(long fileEntryTypeId, java.util.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 DLFolder	deleteFolder(DLFolder dlFolder)
static DLFolder	deleteFolder(DLFolder dlFolder, boolean includeTrashedEntries)
static DLFolder	deleteFolder(long folderId)
static DLFolder	deleteFolder(long folderId, boolean includeTrashedEntries)
static DLFolder	deleteFolder(long userId, long folderId, boolean includeTrashedEntries)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static DLFolder	fetchDLFolder(long folderId)
static DLFolder	fetchDLFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the document library folder matching the UUID and group.
static DLFolder	fetchFolder(long folderId)
static DLFolder	fetchFolder(long groupId, long parentFolderId, java.lang.String name)
static DLFolder	fetchFolder(java.lang.String uuid, long groupId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<DLFolder>	getCompanyFolders(long companyId, int start, int end)
static int	getCompanyFoldersCount(long companyId)
static java.util.List<DLFolder>	getDLFileEntryTypeDLFolders(long fileEntryTypeId)
static java.util.List<DLFolder>	getDLFileEntryTypeDLFolders(long fileEntryTypeId, int start, int end)
static java.util.List<DLFolder>	getDLFileEntryTypeDLFolders(long fileEntryTypeId, int start, int end, OrderByComparator<DLFolder> orderByComparator)
static int	getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId)
static long[]	getDLFileEntryTypePrimaryKeys(long folderId) Returns the fileEntryTypeIds of the document library file entry types associated with the document library folder.
static DLFolder	getDLFolder(long folderId) Returns the document library folder with the primary key.
static DLFolder	getDLFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the document library folder matching the UUID and group.
static java.util.List<DLFolder>	getDLFolders(int start, int end) Returns a range of all the document library folders.
static java.util.List<DLFolder>	getDLFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the document library folders matching the UUID and company.
static java.util.List<DLFolder>	getDLFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<DLFolder> orderByComparator) Returns a range of document library folders matching the UUID and company.
static int	getDLFoldersCount() Returns the number of document library folders.
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static java.util.List<java.lang.Object>	getFileEntriesAndFileShortcuts(long groupId, long folderId, QueryDefinition<?> queryDefinition)
static int	getFileEntriesAndFileShortcutsCount(long groupId, long folderId, QueryDefinition<?> queryDefinition)
static DLFolder	getFolder(long folderId)
static DLFolder	getFolder(long groupId, long parentFolderId, java.lang.String name)
static long	getFolderId(long companyId, long folderId)
static java.util.List<DLFolder>	getFolders(long groupId, long parentFolderId)
static java.util.List<DLFolder>	getFolders(long groupId, long parentFolderId, boolean includeMountfolders)
static java.util.List<DLFolder>	getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int status, int start, int end, OrderByComparator<DLFolder> orderByComparator)
static java.util.List<DLFolder>	getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int start, int end, OrderByComparator<DLFolder> orderByComparator)
static java.util.List<DLFolder>	getFolders(long groupId, long parentFolderId, int status, boolean includeMountfolders, int start, int end, OrderByComparator<DLFolder> orderByComparator) Deprecated. As of Athanasius (7.3.x), replaced by getFolders(long, long, boolean, int, int, OrderByComparator)
static java.util.List<DLFolder>	getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator)
static java.util.List<java.lang.Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, java.lang.String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
static int	getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, java.lang.String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
static int	getFoldersCount(long groupId, long parentFolderId)
static int	getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders)
static int	getFoldersCount(long groupId, long parentFolderId, boolean includeMountfolders, int status)
static int	getFoldersCount(long groupId, long parentFolderId, int status, boolean includeMountfolders) Deprecated. As of Athanasius (7.3.x), replaced by getFoldersCount(long, long, boolean, int)
static java.util.List<java.lang.Long>	getGroupFolderIds(long groupId, long parentFolderId)
static void	getGroupSubfolderIds(java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static DLFolder	getMountFolder(long repositoryId)
static java.util.List<DLFolder>	getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator)
static int	getMountFoldersCount(long groupId, long parentFolderId)
static java.util.List<DLFolder>	getNoAssetFolders()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static java.util.List<java.lang.Long>	getRepositoryFolderIds(long repositoryId, long parentFolderId)
static java.util.List<DLFolder>	getRepositoryFolders(long repositoryId, int start, int end)
static int	getRepositoryFoldersCount(long repositoryId)
static void	getRepositorySubfolderIds(java.util.List<java.lang.Long> folderIds, long repositoryId, long folderId)
static DLFolderLocalService	getService()
static java.lang.String	getUniqueFolderName(java.lang.String uuid, long groupId, long parentFolderId, java.lang.String name, int count)
static boolean	hasDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
static boolean	hasDLFileEntryTypeDLFolders(long fileEntryTypeId)
static boolean	hasFolderLock(long userId, long folderId)
static boolean	hasInheritableLock(long folderId)
static Lock	lockFolder(long userId, long folderId)
static Lock	lockFolder(long userId, long folderId, java.lang.String owner, boolean inheritable, long expirationTime)
static DLFolder	moveFolder(long userId, long folderId, long parentFolderId, ServiceContext serviceContext)
static void	rebuildTree(long companyId)
static void	rebuildTree(long companyId, long parentFolderId, java.lang.String parentTreePath, boolean reindex)
static void	setDLFileEntryTypeDLFolders(long fileEntryTypeId, long[] folderIds)
static void	unlockFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String lockUuid)
static void	unlockFolder(long folderId, java.lang.String lockUuid)
static DLFolder	updateDLFolder(DLFolder dlFolder) Updates the document library folder in the database or adds it if it does not yet exist.
static DLFolder	updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description, long defaultFileEntryTypeId, java.util.List<java.lang.Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
static DLFolder	updateFolder(long folderId, java.lang.String name, java.lang.String description, long defaultFileEntryTypeId, java.util.List<java.lang.Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
static DLFolder	updateFolderAndFileEntryTypes(long userId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, long defaultFileEntryTypeId, java.util.List<java.lang.Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
static void	updateLastPostDate(long folderId, java.util.Date lastPostDate)
static DLFolder	updateStatus(long userId, long folderId, int status, java.util.Map<java.lang.String,java.io.Serializable> workflowContext, ServiceContext serviceContext)
static boolean	verifyInheritableLock(long folderId, java.lang.String lockUuid)

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

addDLFileEntryTypeDLFolder

public static void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                              DLFolder dlFolder)

addDLFileEntryTypeDLFolder

public static void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                              long folderId)

addDLFileEntryTypeDLFolders

public static void addDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                               java.util.List<DLFolder> dlFolders)

addDLFileEntryTypeDLFolders

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

addDLFolder

public static DLFolder addDLFolder(DLFolder dlFolder)

Adds the document library folder to the database. Also notifies the appropriate model listeners.

Important: Inspect DLFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was added

addFolder

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

Throws:

PortalException

clearDLFileEntryTypeDLFolders

public static void clearDLFileEntryTypeDLFolders(long fileEntryTypeId)

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

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteAllByGroup

public static void deleteAllByGroup(long groupId)
                             throws PortalException

Throws:

PortalException

deleteAllByRepository

public static void deleteAllByRepository(long repositoryId)
                                  throws PortalException

Throws:

PortalException

deleteDLFileEntryTypeDLFolder

public static void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                 DLFolder dlFolder)

deleteDLFileEntryTypeDLFolder

public static void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                 long folderId)

deleteDLFileEntryTypeDLFolders

public static void deleteDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                  java.util.List<DLFolder> dlFolders)

deleteDLFileEntryTypeDLFolders

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

deleteDLFolder

public static DLFolder deleteDLFolder(DLFolder dlFolder)

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

Important: Inspect DLFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was removed

deleteDLFolder

public static DLFolder deleteDLFolder(long folderId)
                               throws PortalException

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

Important: Inspect DLFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

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

deleteFolder

public static DLFolder deleteFolder(DLFolder dlFolder)
                             throws PortalException

Throws:

PortalException

deleteFolder

public static DLFolder deleteFolder(DLFolder dlFolder,
                                    boolean includeTrashedEntries)
                             throws PortalException

Throws:

PortalException

deleteFolder

public static DLFolder deleteFolder(long folderId)
                             throws PortalException

Throws:

PortalException

deleteFolder

public static DLFolder deleteFolder(long folderId,
                                    boolean includeTrashedEntries)
                             throws PortalException

Throws:

PortalException

deleteFolder

public static DLFolder deleteFolder(long userId,
                                    long folderId,
                                    boolean includeTrashedEntries)
                             throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl.

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

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<T> orderByComparator)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl.

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchDLFolder

public static DLFolder fetchDLFolder(long folderId)

fetchDLFolderByUuidAndGroupId

public static DLFolder fetchDLFolderByUuidAndGroupId(java.lang.String uuid,
                                                     long groupId)

Returns the document library folder matching the UUID and group.

Parameters:

uuid - the document library folder's UUID

groupId - the primary key of the group

Returns:

the matching document library folder, or null if a matching document library folder could not be found

fetchFolder

public static DLFolder fetchFolder(long folderId)

fetchFolder

public static DLFolder fetchFolder(long groupId,
                                   long parentFolderId,
                                   java.lang.String name)

fetchFolder

public static DLFolder fetchFolder(java.lang.String uuid,
                                   long groupId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCompanyFolders

public static java.util.List<DLFolder> getCompanyFolders(long companyId,
                                                         int start,
                                                         int end)

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)

getDLFileEntryTypeDLFolders

public static java.util.List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId)

getDLFileEntryTypeDLFolders

public static java.util.List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                                   int start,
                                                                   int end)

getDLFileEntryTypeDLFolders

public static java.util.List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator<DLFolder> orderByComparator)

getDLFileEntryTypeDLFoldersCount

public static int getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId)

getDLFileEntryTypePrimaryKeys

public static long[] getDLFileEntryTypePrimaryKeys(long folderId)

Returns the fileEntryTypeIds of the document library file entry types associated with the document library folder.

Parameters:

folderId - the folderId of the document library folder

Returns:

long[] the fileEntryTypeIds of document library file entry types associated with the document library folder

getDLFolder

public static DLFolder getDLFolder(long folderId)
                            throws PortalException

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

getDLFolderByUuidAndGroupId

public static DLFolder getDLFolderByUuidAndGroupId(java.lang.String uuid,
                                                   long groupId)
                                            throws PortalException

Returns the document library folder matching the UUID and group.

Parameters:

uuid - the document library folder's UUID

groupId - the primary key of the group

Returns:

the matching document library folder

Throws:

PortalException - if a matching document library folder could not be found

getDLFolders

public static java.util.List<DLFolder> getDLFolders(int start,
                                                    int end)

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 com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl.

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

getDLFoldersByUuidAndCompanyId

public static java.util.List<DLFolder> getDLFoldersByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId)

Returns all the document library folders matching the UUID and company.

Parameters:

uuid - the UUID of the document library folders

companyId - the primary key of the company

Returns:

the matching document library folders, or an empty list if no matches were found

getDLFoldersByUuidAndCompanyId

public static java.util.List<DLFolder> getDLFoldersByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator<DLFolder> orderByComparator)

Returns a range of document library folders matching the UUID and company.

Parameters:

uuid - the UUID of the document library folders

companyId - the primary key of the company

start - the lower bound of the range of document library folders

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

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

Returns:

the range of matching document library folders, or an empty list if no matches were found

getDLFoldersCount

public static int getDLFoldersCount()

Returns the number of document library folders.

Returns:

the number of document library folders

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFileEntriesAndFileShortcuts

public static java.util.List<java.lang.Object> getFileEntriesAndFileShortcuts(long groupId,
                                                                              long folderId,
                                                                              QueryDefinition<?> queryDefinition)

getFileEntriesAndFileShortcutsCount

public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                      long folderId,
                                                      QueryDefinition<?> queryDefinition)

getFolder

public static DLFolder getFolder(long folderId)
                          throws PortalException

Throws:

PortalException

getFolder

public static DLFolder getFolder(long groupId,
                                 long parentFolderId,
                                 java.lang.String name)
                          throws PortalException

Throws:

PortalException

getFolderId

public static long getFolderId(long companyId,
                               long folderId)

getFolders

public static java.util.List<DLFolder> getFolders(long groupId,
                                                  long parentFolderId)

getFolders

public static java.util.List<DLFolder> getFolders(long groupId,
                                                  long parentFolderId,
                                                  boolean includeMountfolders)

getFolders

public static java.util.List<DLFolder> getFolders(long groupId,
                                                  long parentFolderId,
                                                  boolean includeMountfolders,
                                                  int status,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<DLFolder> orderByComparator)

getFolders

public static java.util.List<DLFolder> getFolders(long groupId,
                                                  long parentFolderId,
                                                  boolean includeMountfolders,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<DLFolder> orderByComparator)

getFolders

@Deprecated
public static java.util.List<DLFolder> getFolders(long groupId,
                                                              long parentFolderId,
                                                              int status,
                                                              boolean includeMountfolders,
                                                              int start,
                                                              int end,
                                                              OrderByComparator<DLFolder> orderByComparator)

Deprecated. As of Athanasius (7.3.x), replaced by getFolders(long, long, boolean, int, int, OrderByComparator)

getFolders

public static java.util.List<DLFolder> getFolders(long groupId,
                                                  long parentFolderId,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<DLFolder> orderByComparator)

getFoldersAndFileEntriesAndFileShortcuts

public static java.util.List<java.lang.Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                        long folderId,
                                                                                        java.lang.String[] mimeTypes,
                                                                                        boolean includeMountFolders,
                                                                                        QueryDefinition<?> queryDefinition)

getFoldersAndFileEntriesAndFileShortcutsCount

public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                long folderId,
                                                                java.lang.String[] mimeTypes,
                                                                boolean includeMountFolders,
                                                                QueryDefinition<?> queryDefinition)

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)

getFoldersCount

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

getFoldersCount

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

getFoldersCount

@Deprecated
public static int getFoldersCount(long groupId,
                                              long parentFolderId,
                                              int status,
                                              boolean includeMountfolders)

Deprecated. As of Athanasius (7.3.x), replaced by getFoldersCount(long, long, boolean, int)

getGroupFolderIds

public static java.util.List<java.lang.Long> getGroupFolderIds(long groupId,
                                                               long parentFolderId)

getGroupSubfolderIds

public static void getGroupSubfolderIds(java.util.List<java.lang.Long> folderIds,
                                        long groupId,
                                        long folderId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMountFolder

public static DLFolder getMountFolder(long repositoryId)
                               throws PortalException

Throws:

PortalException

getMountFolders

public static java.util.List<DLFolder> getMountFolders(long groupId,
                                                       long parentFolderId,
                                                       int start,
                                                       int end,
                                                       OrderByComparator<DLFolder> orderByComparator)

getMountFoldersCount

public static int getMountFoldersCount(long groupId,
                                       long parentFolderId)

getNoAssetFolders

public static java.util.List<DLFolder> getNoAssetFolders()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getRepositoryFolderIds

public static java.util.List<java.lang.Long> getRepositoryFolderIds(long repositoryId,
                                                                    long parentFolderId)

getRepositoryFolders

public static java.util.List<DLFolder> getRepositoryFolders(long repositoryId,
                                                            int start,
                                                            int end)

getRepositoryFoldersCount

public static int getRepositoryFoldersCount(long repositoryId)

getRepositorySubfolderIds

public static void getRepositorySubfolderIds(java.util.List<java.lang.Long> folderIds,
                                             long repositoryId,
                                             long folderId)

getUniqueFolderName

public static java.lang.String getUniqueFolderName(java.lang.String uuid,
                                                   long groupId,
                                                   long parentFolderId,
                                                   java.lang.String name,
                                                   int count)

hasDLFileEntryTypeDLFolder

public static boolean hasDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                 long folderId)

hasDLFileEntryTypeDLFolders

public static boolean hasDLFileEntryTypeDLFolders(long fileEntryTypeId)

hasFolderLock

public static boolean hasFolderLock(long userId,
                                    long folderId)

hasInheritableLock

public static boolean hasInheritableLock(long folderId)

lockFolder

public static Lock lockFolder(long userId,
                              long folderId)
                       throws PortalException

Throws:

PortalException

lockFolder

public static Lock lockFolder(long userId,
                              long folderId,
                              java.lang.String owner,
                              boolean inheritable,
                              long expirationTime)
                       throws PortalException

Throws:

PortalException

moveFolder

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

Throws:

PortalException

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException

Throws:

PortalException

rebuildTree

public static void rebuildTree(long companyId,
                               long parentFolderId,
                               java.lang.String parentTreePath,
                               boolean reindex)
                        throws PortalException

Throws:

PortalException

setDLFileEntryTypeDLFolders

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

unlockFolder

public static void unlockFolder(long groupId,
                                long parentFolderId,
                                java.lang.String name,
                                java.lang.String lockUuid)
                         throws PortalException

Throws:

PortalException

unlockFolder

public static void unlockFolder(long folderId,
                                java.lang.String lockUuid)
                         throws PortalException

Throws:

PortalException

updateDLFolder

public static DLFolder updateDLFolder(DLFolder dlFolder)

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

Important: Inspect DLFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was updated

updateFolder

public static DLFolder updateFolder(long folderId,
                                    long parentFolderId,
                                    java.lang.String name,
                                    java.lang.String description,
                                    long defaultFileEntryTypeId,
                                    java.util.List<java.lang.Long> fileEntryTypeIds,
                                    int restrictionType,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:

PortalException

updateFolder

public static DLFolder updateFolder(long folderId,
                                    java.lang.String name,
                                    java.lang.String description,
                                    long defaultFileEntryTypeId,
                                    java.util.List<java.lang.Long> fileEntryTypeIds,
                                    int restrictionType,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:

PortalException

updateFolderAndFileEntryTypes

public static DLFolder updateFolderAndFileEntryTypes(long userId,
                                                     long folderId,
                                                     long parentFolderId,
                                                     java.lang.String name,
                                                     java.lang.String description,
                                                     long defaultFileEntryTypeId,
                                                     java.util.List<java.lang.Long> fileEntryTypeIds,
                                                     int restrictionType,
                                                     ServiceContext serviceContext)
                                              throws PortalException

Throws:

PortalException

updateLastPostDate

public static void updateLastPostDate(long folderId,
                                      java.util.Date lastPostDate)
                               throws PortalException

Throws:

PortalException

updateStatus

public static DLFolder updateStatus(long userId,
                                    long folderId,
                                    int status,
                                    java.util.Map<java.lang.String,java.io.Serializable> workflowContext,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:

PortalException

verifyInheritableLock

public static boolean verifyInheritableLock(long folderId,
                                            java.lang.String lockUuid)
                                     throws PortalException

Throws:

PortalException

getService

public static DLFolderLocalService getService()