Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Interface DLFolderLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DLFolderLocalServiceBaseImpl, DLFolderLocalServiceImpl, DLFolderLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFolderLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for DLFolder. 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:
DLFolderLocalServiceUtil, DLFolderLocalServiceBaseImpl, DLFolderLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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

Method Detail

addDLFileEntryTypeDLFolder

void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                DLFolder dlFolder)

addDLFileEntryTypeDLFolder

void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                long folderId)

addDLFileEntryTypeDLFolders

void addDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                 List<DLFolder> DLFolders)

addDLFileEntryTypeDLFolders

void addDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                 long[] folderIds)

addDLFolder

@Indexable(type=REINDEX)
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

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

void clearDLFileEntryTypeDLFolders(long fileEntryTypeId)

createDLFolder

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
void deleteAll(long groupId)
               throws PortalException
Deprecated. As of 7.0.0, replaced by deleteAllByGroup(long)

Throws:
PortalException

deleteAllByGroup

void deleteAllByGroup(long groupId)
                      throws PortalException
Throws:
PortalException

deleteAllByRepository

void deleteAllByRepository(long repositoryId)
                           throws PortalException
Throws:
PortalException

deleteDLFileEntryTypeDLFolder

void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                   DLFolder dlFolder)

deleteDLFileEntryTypeDLFolder

void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                   long folderId)

deleteDLFileEntryTypeDLFolders

void deleteDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                    List<DLFolder> DLFolders)

deleteDLFileEntryTypeDLFolders

void deleteDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                    long[] folderIds)

deleteDLFolder

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
@SystemEvent(action=1,
             type=1)
DLFolder deleteFolder(DLFolder dlFolder)
                      throws PortalException
Throws:
PortalException

deleteFolder

@Indexable(type=DELETE)
@SystemEvent(action=1,
             type=1)
DLFolder deleteFolder(DLFolder dlFolder,
                                                                boolean includeTrashedEntries)
                      throws PortalException
Throws:
PortalException

deleteFolder

@Indexable(type=DELETE)
DLFolder deleteFolder(long folderId)
                      throws PortalException
Throws:
PortalException

deleteFolder

@Indexable(type=DELETE)
DLFolder deleteFolder(long folderId,
                                          boolean includeTrashedEntries)
                      throws PortalException
Throws:
PortalException

deleteFolder

@Indexable(type=DELETE)
DLFolder deleteFolder(long userId,
                                          long folderId,
                                          boolean includeTrashedEntries)
                      throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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

<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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder fetchDLFolder(long folderId)

fetchDLFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder fetchFolder(long folderId)

fetchFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder fetchFolder(long groupId,
                                                              long parentFolderId,
                                                              String name)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getCompanyFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getCompanyFolders(long companyId,
                                                                          int start,
                                                                          int end)

getCompanyFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyFoldersCount(long companyId)

getDLFileEntryTypeDLFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId)

getDLFileEntryTypeDLFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                                                    int start,
                                                                                    int end)

getDLFileEntryTypeDLFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                                                                    int start,
                                                                                    int end,
                                                                                    OrderByComparator<DLFolder> orderByComparator)

getDLFileEntryTypeDLFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId)

getDLFileEntryTypePrimaryKeys

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFoldersCount()
Returns the number of document library folders.

Returns:
the number of document library folders

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                                                     long folderId,
                                                                                     QueryDefinition<?> queryDefinition)

getFileEntriesAndFileShortcuts

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                                 long folderId,
                                                                                 QueryDefinition<?> queryDefinition)

getFileEntriesAndFileShortcutsCount

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesAndFileShortcutsCount(long groupId,
                                                                                            long folderId,
                                                                                            int status)
Deprecated. As of 6.2.0, replaced by getFileEntriesAndFileShortcutsCount(long, long, QueryDefinition)


getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long folderId)
                   throws PortalException
Throws:
PortalException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getFolder(long groupId,
                                                            long parentFolderId,
                                                            String name)
                   throws PortalException
Throws:
PortalException

getFolderId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long getFolderId(long companyId,
                                                          long folderId)

getFolderIds

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Long> getFolderIds(long groupId,
                                                                            long parentFolderId)
Deprecated. As of 7.0.0, replaced by getGroupFolderIds(long, long)


getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   boolean includeMountfolders)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   boolean includeMountfolders,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator<DLFolder> obc)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator<DLFolder> obc)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   int status,
                                                                   boolean includeMountfolders,
                                                                   int start,
                                                                   int end,
                                                                   OrderByComparator<DLFolder> obc)

getFoldersAndFileEntriesAndFileShortcuts

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndFileEntriesAndFileShortcuts(long groupId,
                                                                                               long folderId,
                                                                                               String[] mimeTypes,
                                                                                               boolean includeMountFolders,
                                                                                               QueryDefinition<?> queryDefinition)

getFoldersAndFileEntriesAndFileShortcuts

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndFileEntriesAndFileShortcutsCount(long groupId,
                                                                                           long folderId,
                                                                                           String[] mimeTypes,
                                                                                           boolean includeMountFolders,
                                                                                           QueryDefinition<?> queryDefinition)

getFoldersAndFileEntriesAndFileShortcutsCount

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId)

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId,
                                                             boolean includeMountfolders)

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId,
                                                             int status,
                                                             boolean includeMountfolders)

getGroupFolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Long> getGroupFolderIds(long groupId,
                                                                      long parentFolderId)

getGroupSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getGroupSubfolderIds(List<Long> folderIds,
                                                                   long groupId,
                                                                   long folderId)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMountFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFolder getMountFolder(long repositoryId)
                        throws PortalException
Throws:
PortalException

getMountFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getMountFolders(long groupId,
                                                                        long parentFolderId,
                                                                        int start,
                                                                        int end,
                                                                        OrderByComparator<DLFolder> obc)

getMountFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMountFoldersCount(long groupId,
                                                                  long parentFolderId)

getNoAssetFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getNoAssetFolders()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getRepositoryFolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Long> getRepositoryFolderIds(long repositoryId,
                                                                           long parentFolderId)

getRepositoryFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFolder> getRepositoryFolders(long repositoryId,
                                                                             int start,
                                                                             int end)

getRepositoryFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRepositoryFoldersCount(long repositoryId)

getRepositorySubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getRepositorySubfolderIds(List<Long> folderIds,
                                                                        long repositoryId,
                                                                        long folderId)

getSubfolderIds

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                                         long groupId,
                                                                         long folderId)
Deprecated. As of 7.0.0, replaced by getGroupSubfolderIds(List, long, long)


hasDLFileEntryTypeDLFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                                                            long folderId)

hasDLFileEntryTypeDLFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasDLFileEntryTypeDLFolders(long fileEntryTypeId)

hasFolderLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFolderLock(long userId,
                                                               long folderId)

hasInheritableLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasInheritableLock(long folderId)
                           throws PortalException
Throws:
PortalException

lockFolder

Lock lockFolder(long userId,
                long folderId)
                throws PortalException
Throws:
PortalException

lockFolder

Lock lockFolder(long userId,
                long folderId,
                String owner,
                boolean inheritable,
                long expirationTime)
                throws PortalException
Throws:
PortalException

moveFolder

@Indexable(type=REINDEX)
DLFolder moveFolder(long userId,
                                         long folderId,
                                         long parentFolderId,
                                         ServiceContext serviceContext)
                    throws PortalException
Throws:
PortalException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException
Throws:
PortalException

rebuildTree

void rebuildTree(long companyId,
                 long parentFolderId,
                 String parentTreePath,
                 boolean reindex)
                 throws PortalException
Throws:
PortalException

setDLFileEntryTypeDLFolders

void setDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                 long[] folderIds)

unlockFolder

void unlockFolder(long folderId,
                  String lockUuid)
                  throws PortalException
Throws:
PortalException

unlockFolder

void unlockFolder(long groupId,
                  long parentFolderId,
                  String name,
                  String lockUuid)
                  throws PortalException
Throws:
PortalException

updateDLFolder

@Indexable(type=REINDEX)
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
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

@Indexable(type=REINDEX)
DLFolder updateFolder(long folderId,
                                           String name,
                                           String description,
                                           long defaultFileEntryTypeId,
                                           List<Long> fileEntryTypeIds,
                                           int restrictionType,
                                           ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

updateFolder

@Deprecated
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

@Indexable(type=REINDEX)
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
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

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

@BufferedIncrement(configuration="DLFolderEntry",
                   incrementClass=DateOverrideIncrement.class)
void updateLastPostDate(long folderId,
                                                                                                Date lastPostDate)
                        throws PortalException
Throws:
PortalException

updateStatus

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

verifyInheritableLock

boolean verifyInheritableLock(long folderId,
                              String lockUuid)
                              throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4