Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Class DLFolderLocalServiceUtil

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

@ProviderType
public class DLFolderLocalServiceUtil
extends Object

Provides the local service utility for DLFolder. This utility wraps DLFolderLocalServiceImpl and is the primary 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.

See Also:
DLFolderLocalService, DLFolderLocalServiceBaseImpl, DLFolderLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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, boolean hidden, ServiceContext serviceContext)
           
static DLFolder addFolder(long userId, long groupId, long repositoryId, boolean mountPoint, long parentFolderId, String name, String description, ServiceContext serviceContext)
          Deprecated. As of 6.2.0, replaced by more general addFolder(long, long, long, boolean, long, String, String, boolean, 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)
          Deprecated. As of 7.0.0, replaced by deleteAllByGroup(long)
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, 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 DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
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.
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.
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(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, String name)
           
static ActionableDynamicQuery getActionableDynamicQuery()
           
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<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(String uuid, long groupId)
          Returns the document library folder matching the UUID and group.
static List<DLFolder> getDLFolders(int start, int end)
          Returns a range of all the document library folders.
static List<DLFolder> getDLFoldersByUuidAndCompanyId(String uuid, long companyId)
          Returns all the document library folders matching the UUID and company.
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.
static int getDLFoldersCount()
          Returns the number of document library folders.
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static List<Object> getFileEntriesAndFileShortcuts(long groupId, long folderId, int status, int start, int end)
          Deprecated. As of 6.2.0, replaced by getFileEntriesAndFileShortcuts(long, long, QueryDefinition)
static List<Object> getFileEntriesAndFileShortcuts(long groupId, long folderId, QueryDefinition<?> queryDefinition)
           
static int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status)
          Deprecated. As of 6.2.0, replaced by getFileEntriesAndFileShortcutsCount(long, long, QueryDefinition)
static int getFileEntriesAndFileShortcutsCount(long groupId, long folderId, QueryDefinition<?> queryDefinition)
           
static DLFolder getFolder(long folderId)
           
static DLFolder getFolder(long groupId, long parentFolderId, String name)
           
static long getFolderId(long companyId, long folderId)
           
static List<Long> getFolderIds(long groupId, long parentFolderId)
          Deprecated. As of 7.0.0, replaced by getGroupFolderIds(long, long)
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<DLFolder> obc)
           
static List<DLFolder> getFolders(long groupId, long parentFolderId, int status, boolean includeMountfolders, int start, int end, OrderByComparator<DLFolder> obc)
           
static List<DLFolder> getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> obc)
           
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
          Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcuts(long, long, String[], boolean, QueryDefinition)
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders, int start, int end, OrderByComparator<?> obc)
          Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, QueryDefinition)
static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> queryDefinition)
           
static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, boolean includeMountFolders)
          Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, QueryDefinition)
static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, int status, String[] mimeTypes, boolean includeMountFolders)
          Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, QueryDefinition)
static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId, long folderId, 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, int status, boolean includeMountfolders)
           
static List<Long> getGroupFolderIds(long groupId, long parentFolderId)
           
static void getGroupSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static DLFolder getMountFolder(long repositoryId)
           
static List<DLFolder> getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> obc)
           
static int getMountFoldersCount(long groupId, long parentFolderId)
           
static List<DLFolder> getNoAssetFolders()
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static List<Long> getRepositoryFolderIds(long repositoryId, long parentFolderId)
           
static List<DLFolder> getRepositoryFolders(long repositoryId, int start, int end)
           
static int getRepositoryFoldersCount(long repositoryId)
           
static void getRepositorySubfolderIds(List<Long> folderIds, long repositoryId, long folderId)
           
static DLFolderLocalService getService()
           
static void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
          Deprecated. As of 7.0.0, replaced by getGroupSubfolderIds(List, long, long)
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, 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, String parentTreePath, boolean reindex)
           
static void setDLFileEntryTypeDLFolders(long fileEntryTypeId, long[] folderIds)
           
static void unlockFolder(long groupId, long parentFolderId, String name, String lockUuid)
           
static void unlockFolder(long folderId, 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, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateFolder(long, long, String, String, long, List, int, ServiceContext)
static DLFolder updateFolder(long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
           
static DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced updateFolder(long, long, String, String, long, List, int, ServiceContext)
static DLFolder updateFolder(long folderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
           
static DLFolder updateFolderAndFileEntryTypes(long userId, long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, boolean overrideFileEntryTypes, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateFolderAndFileEntryTypes(long, long, long, String, String, long, List, int, ServiceContext)
static DLFolder updateFolderAndFileEntryTypes(long userId, long folderId, long parentFolderId, String name, String description, long defaultFileEntryTypeId, List<Long> fileEntryTypeIds, int restrictionType, ServiceContext serviceContext)
           
static void updateLastPostDate(long folderId, Date lastPostDate)
           
static DLFolder updateStatus(long userId, long folderId, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext)
           
static boolean verifyInheritableLock(long folderId, 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,
                                               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.

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,
                                 String name,
                                 String description,
                                 boolean hidden,
                                 ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

addFolder

@Deprecated
public static DLFolder addFolder(long userId,
                                            long groupId,
                                            long repositoryId,
                                            boolean mountPoint,
                                            long parentFolderId,
                                            String name,
                                            String description,
                                            ServiceContext serviceContext)
                          throws PortalException
Deprecated. As of 6.2.0, replaced by more general addFolder(long, long, long, boolean, long, String, String, boolean, ServiceContext)

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

deleteAll

@Deprecated
public static void deleteAll(long groupId)
                      throws PortalException
Deprecated. As of 7.0.0, replaced by deleteAllByGroup(long)

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.

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.

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

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFolderModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFolderModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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(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)

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

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFolderModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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)

getFileEntriesAndFileShortcuts

@Deprecated
public static List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                                     long folderId,
                                                                     int status,
                                                                     int start,
                                                                     int end)
Deprecated. As of 6.2.0, replaced by getFileEntriesAndFileShortcuts(long, long, QueryDefinition)


getFileEntriesAndFileShortcutsCount

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

getFileEntriesAndFileShortcutsCount

@Deprecated
public static int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                 long folderId,
                                                                 int status)
Deprecated. As of 6.2.0, replaced by getFileEntriesAndFileShortcutsCount(long, long, 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)

getFolderIds

@Deprecated
public static List<Long> getFolderIds(long groupId,
                                                 long parentFolderId)
Deprecated. As of 7.0.0, replaced by getGroupFolderIds(long, long)


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 start,
                                        int end,
                                        OrderByComparator<DLFolder> obc)

getFolders

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

getFolders

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

getFoldersAndFileEntriesAndFileShortcuts

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

getFoldersAndFileEntriesAndFileShortcuts

@Deprecated
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                               long folderId,
                                                                               int status,
                                                                               boolean includeMountFolders,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<?> obc)
Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcuts(long, long, String[], boolean, QueryDefinition)


getFoldersAndFileEntriesAndFileShortcuts

@Deprecated
public static List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                               long folderId,
                                                                               int status,
                                                                               String[] mimeTypes,
                                                                               boolean includeMountFolders,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<?> obc)
Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, QueryDefinition)


getFoldersAndFileEntriesAndFileShortcutsCount

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

getFoldersAndFileEntriesAndFileShortcutsCount

@Deprecated
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                           long folderId,
                                                                           int status,
                                                                           boolean includeMountFolders)
Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, QueryDefinition)


getFoldersAndFileEntriesAndFileShortcutsCount

@Deprecated
public static int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                           long folderId,
                                                                           int status,
                                                                           String[] mimeTypes,
                                                                           boolean includeMountFolders)
Deprecated. As of 6.2.0, replaced by getFoldersAndFileEntriesAndFileShortcutsCount(long, long, String[], boolean, 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,
                                  int status,
                                  boolean includeMountfolders)

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> obc)

getMountFoldersCount

public static int getMountFoldersCount(long groupId,
                                       long parentFolderId)

getNoAssetFolders

public static List<DLFolder> getNoAssetFolders()

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)

getSubfolderIds

@Deprecated
public static void getSubfolderIds(List<Long> folderIds,
                                              long groupId,
                                              long folderId)
Deprecated. As of 7.0.0, replaced by getGroupSubfolderIds(List, long, long)


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)
                                  throws PortalException
Throws:
PortalException

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 folderId,
                                String lockUuid)
                         throws PortalException
Throws:
PortalException

unlockFolder

public static void unlockFolder(long groupId,
                                long parentFolderId,
                                String name,
                                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.

Parameters:
dlFolder - the document library folder
Returns:
the document library folder that was updated

updateFolder

@Deprecated
public static DLFolder updateFolder(long folderId,
                                               String name,
                                               String description,
                                               long defaultFileEntryTypeId,
                                               List<Long> fileEntryTypeIds,
                                               boolean overrideFileEntryTypes,
                                               ServiceContext serviceContext)
                             throws PortalException
Deprecated. As of 7.0.0, replaced updateFolder(long, long, String, String, long, List, int, ServiceContext)

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

updateFolder

@Deprecated
public static DLFolder updateFolder(long folderId,
                                               long parentFolderId,
                                               String name,
                                               String description,
                                               long defaultFileEntryTypeId,
                                               List<Long> fileEntryTypeIds,
                                               boolean overrideFileEntryTypes,
                                               ServiceContext serviceContext)
                             throws PortalException
Deprecated. As of 7.0.0, replaced by updateFolder(long, long, String, String, long, List, int, ServiceContext)

Throws:
PortalException

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

updateFolderAndFileEntryTypes

@Deprecated
public static DLFolder updateFolderAndFileEntryTypes(long userId,
                                                                long folderId,
                                                                long parentFolderId,
                                                                String name,
                                                                String description,
                                                                long defaultFileEntryTypeId,
                                                                List<Long> fileEntryTypeIds,
                                                                boolean overrideFileEntryTypes,
                                                                ServiceContext serviceContext)
                                              throws PortalException
Deprecated. As of 7.0.0, replaced by updateFolderAndFileEntryTypes(long, long, long, String, String, long, List, int, ServiceContext)

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()

Liferay 7.0-ce-b4