Class DLFolderLocalServiceUtil

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

public class DLFolderLocalServiceUtil extends 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:
{$generated.description}
  • Constructor Details

    • DLFolderLocalServiceUtil

      public DLFolderLocalServiceUtil()
  • Method Details

    • addDLFileEntryTypeDLFolder

      public static boolean addDLFileEntryTypeDLFolder(long fileEntryTypeId, DLFolder dlFolder)
    • addDLFileEntryTypeDLFolder

      public static boolean addDLFileEntryTypeDLFolder(long fileEntryTypeId, long folderId)
    • addDLFileEntryTypeDLFolders

      public static boolean addDLFileEntryTypeDLFolders(long fileEntryTypeId, List<DLFolder> dlFolders)
    • addDLFileEntryTypeDLFolders

      public static boolean 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(String externalReferenceCode, long userId, long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, 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(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, 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> 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> 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> 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)
    • fetchDLFolderByExternalReferenceCode

      public static DLFolder fetchDLFolderByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchDLFolderByUuidAndGroupId

      public static DLFolder fetchDLFolderByUuidAndGroupId(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, String name)
    • fetchFolder

      public static DLFolder fetchFolder(String uuid, long groupId)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getCompanyFolders

      public static List<DLFolder> getCompanyFolders(long companyId, int start, int end)
    • getCompanyFoldersCount

      public static int getCompanyFoldersCount(long companyId)
    • getDLFileEntryTypeDLFolders

      public static List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId)
    • getDLFileEntryTypeDLFolders

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

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

      public static DLFolder getDLFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Throws:
      PortalException
    • getDLFolderByUuidAndGroupId

      public static DLFolder getDLFolderByUuidAndGroupId(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 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 List<DLFolder> getDLFoldersByUuidAndCompanyId(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 List<DLFolder> getDLFoldersByUuidAndCompanyId(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 List<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, String name) throws PortalException
      Throws:
      PortalException
    • getFolderId

      public static long getFolderId(long companyId, long folderId)
    • getFolders

      public static List<DLFolder> getFolders(long groupId, boolean mountPoint, String treePath, boolean hidden)
    • getFolders

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

      public static List<DLFolder> getFolders(long groupId, long parentFolderId, boolean includeMountfolders)
    • getFolders

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

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

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

      public static List<DLFolder> getFolders(long classNameId, String treePath)
    • getFoldersAndFileEntriesAndFileShortcuts

      public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
    • getFoldersAndFileEntriesAndFileShortcutsCount

      public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, 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)
    • getFolderSize

      public static long getFolderSize(long companyId, long groupId, String treePath)
    • getGroupFolderIds

      public static List<Long> getGroupFolderIds(long groupId, long parentFolderId)
    • getGroupSubfolderIds

      public static void getGroupSubfolderIds(List<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 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 List<DLFolder> getNoAssetFolders()
    • getNotInTrashFolders

      public static List<DLFolder> getNotInTrashFolders(long groupId, boolean mountPoint, String treePath, boolean hidden)
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getRepositoryFolderIds

      public static List<Long> getRepositoryFolderIds(long repositoryId, long parentFolderId)
    • getRepositoryFolders

      public static List<DLFolder> getRepositoryFolders(long repositoryId, int start, int end)
    • getRepositoryFoldersCount

      public static int getRepositoryFoldersCount(long repositoryId)
    • getRepositorySubfolderIds

      public static void getRepositorySubfolderIds(List<Long> folderIds, long repositoryId, long folderId)
    • getUniqueFolderName

      public static String getUniqueFolderName(String uuid, long groupId, long parentFolderId, 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, 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, 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, String name, String lockUuid) throws PortalException
      Throws:
      PortalException
    • unlockFolder

      public static void unlockFolder(long folderId, 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, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateFolder

      public static DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateFolderAndFileEntryTypes

      public static DLFolder updateFolderAndFileEntryTypes(long userId, long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateLastPostDate

      public static void updateLastPostDate(long folderId, Date lastPostDate) throws PortalException
      Throws:
      PortalException
    • updateStatus

      public static DLFolder updateStatus(long userId, long folderId, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • verifyInheritableLock

      public static boolean verifyInheritableLock(long folderId, String lockUuid) throws PortalException
      Throws:
      PortalException
    • getService

      public static DLFolderLocalService getService()
    • setService

      public static void setService(DLFolderLocalService service)