com.liferay.document.library.kernel.service

Class DLFolderLocalServiceWrapper

Object

com.liferay.document.library.kernel.service.DLFolderLocalServiceWrapper

All Implemented Interfaces:

DLFolderLocalService, BaseLocalService, CTService<DLFolder>, PersistedModelLocalService, ServiceWrapper<DLFolderLocalService>

public class DLFolderLocalServiceWrapper
extends Object
implements DLFolderLocalService, ServiceWrapper<DLFolderLocalService>

Provides a wrapper for DLFolderLocalService.

Author:

Brian Wing Shun Chan

See Also:

DLFolderLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFolderLocalServiceWrapper()
DLFolderLocalServiceWrapper(DLFolderLocalService dlFolderLocalService)

Method Summary

Modifier and Type	Method and Description
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)
void	clearDLFileEntryTypeDLFolders(long fileEntryTypeId)
DLFolder	createDLFolder(long folderId) Creates a new document library folder with the primary key.
PersistedModel	createPersistedModel(Serializable primaryKeyObj)
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)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
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)
DLFolder	fetchFolder(String uuid, long groupId)
ActionableDynamicQuery	getActionableDynamicQuery()
List<DLFolder>	getCompanyFolders(long companyId, int start, int end)
int	getCompanyFoldersCount(long companyId)
CTPersistence<DLFolder>	getCTPersistence()
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, QueryDefinition<?> 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<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 status, int start, int end, OrderByComparator<DLFolder> orderByComparator)
List<DLFolder>	getFolders(long groupId, long parentFolderId, boolean includeMountfolders, int start, int end, OrderByComparator<DLFolder> orderByComparator)
List<DLFolder>	getFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator)
List<Object>	getFoldersAndFileEntriesAndFileShortcuts(long groupId, long folderId, String[] mimeTypes, boolean includeMountFolders, QueryDefinition<?> 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, boolean includeMountfolders, int status)
int	getFoldersCount(long groupId, long parentFolderId, int status, boolean includeMountfolders) Deprecated. As of Athanasius (7.3.x), replaced by getFoldersCount(long, long, boolean, int)
List<Long>	getGroupFolderIds(long groupId, long parentFolderId)
void	getGroupSubfolderIds(List<Long> folderIds, long groupId, long folderId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
Class<DLFolder>	getModelClass()
DLFolder	getMountFolder(long repositoryId)
List<DLFolder>	getMountFolders(long groupId, long parentFolderId, int start, int end, OrderByComparator<DLFolder> orderByComparator)
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)
String	getUniqueFolderName(String uuid, long groupId, long parentFolderId, String name, int count)
DLFolderLocalService	getWrappedService()
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	setWrappedService(DLFolderLocalService dlFolderLocalService)
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, int restrictionType, ServiceContext 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, int restrictionType, ServiceContext serviceContext)
void	updateLastPostDate(long folderId, Date lastPostDate)
DLFolder	updateStatus(long userId, long folderId, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext)
<R,E extends Throwable> R	updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFolder>,R,E> updateUnsafeFunction)
boolean	verifyInheritableLock(long folderId, String lockUuid)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Constructor Detail

DLFolderLocalServiceWrapper

public DLFolderLocalServiceWrapper()

DLFolderLocalServiceWrapper

public DLFolderLocalServiceWrapper(DLFolderLocalService dlFolderLocalService)

Method Detail

addDLFileEntryTypeDLFolder

public void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                       DLFolder dlFolder)

Specified by:

addDLFileEntryTypeDLFolder in interface DLFolderLocalService

addDLFileEntryTypeDLFolder

public void addDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                       long folderId)

Specified by:

addDLFileEntryTypeDLFolder in interface DLFolderLocalService

addDLFileEntryTypeDLFolders

public void addDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                        List<DLFolder> dlFolders)

Specified by:

addDLFileEntryTypeDLFolders in interface DLFolderLocalService

addDLFileEntryTypeDLFolders

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

Specified by:

addDLFileEntryTypeDLFolders in interface DLFolderLocalService

addDLFolder

public DLFolder addDLFolder(DLFolder dlFolder)

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

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

Specified by:

addDLFolder in interface DLFolderLocalService

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was added

addFolder

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

Specified by:

addFolder in interface DLFolderLocalService

Throws:

PortalException

clearDLFileEntryTypeDLFolders

public void clearDLFileEntryTypeDLFolders(long fileEntryTypeId)

Specified by:

clearDLFileEntryTypeDLFolders in interface DLFolderLocalService

createDLFolder

public DLFolder createDLFolder(long folderId)

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

Specified by:

createDLFolder in interface DLFolderLocalService

Parameters:

folderId - the primary key for the new document library folder

Returns:

the new document library folder

createPersistedModel

public PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                    throws PortalException

Specified by:

createPersistedModel in interface DLFolderLocalService

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteAllByGroup

public void deleteAllByGroup(long groupId)
                      throws PortalException

Specified by:

deleteAllByGroup in interface DLFolderLocalService

Throws:

PortalException

deleteAllByRepository

public void deleteAllByRepository(long repositoryId)
                           throws PortalException

Specified by:

deleteAllByRepository in interface DLFolderLocalService

Throws:

PortalException

deleteDLFileEntryTypeDLFolder

public void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                          DLFolder dlFolder)

Specified by:

deleteDLFileEntryTypeDLFolder in interface DLFolderLocalService

deleteDLFileEntryTypeDLFolder

public void deleteDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                          long folderId)

Specified by:

deleteDLFileEntryTypeDLFolder in interface DLFolderLocalService

deleteDLFileEntryTypeDLFolders

public void deleteDLFileEntryTypeDLFolders(long fileEntryTypeId,
                                           List<DLFolder> dlFolders)

Specified by:

deleteDLFileEntryTypeDLFolders in interface DLFolderLocalService

deleteDLFileEntryTypeDLFolders

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

Specified by:

deleteDLFileEntryTypeDLFolders in interface DLFolderLocalService

deleteDLFolder

public DLFolder deleteDLFolder(DLFolder dlFolder)

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

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

Specified by:

deleteDLFolder in interface DLFolderLocalService

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was removed

deleteDLFolder

public DLFolder deleteDLFolder(long folderId)
                        throws PortalException

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

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

Specified by:

deleteDLFolder in interface DLFolderLocalService

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 DLFolder deleteFolder(DLFolder dlFolder)
                      throws PortalException

Specified by:

deleteFolder in interface DLFolderLocalService

Throws:

PortalException

deleteFolder

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

Specified by:

deleteFolder in interface DLFolderLocalService

Throws:

PortalException

deleteFolder

public DLFolder deleteFolder(long folderId)
                      throws PortalException

Specified by:

deleteFolder in interface DLFolderLocalService

Throws:

PortalException

deleteFolder

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

Specified by:

deleteFolder in interface DLFolderLocalService

Throws:

PortalException

deleteFolder

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

Specified by:

deleteFolder in interface DLFolderLocalService

Throws:

PortalException

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface DLFolderLocalService

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

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

Specified by:

dslQuery in interface DLFolderLocalService

Specified by:

dslQuery in interface PersistedModelLocalService

dslQueryCount

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

Specified by:

dslQueryCount in interface DLFolderLocalService

Specified by:

dslQueryCount in interface PersistedModelLocalService

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface DLFolderLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Specified by:

dynamicQuery in interface DLFolderLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)

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

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl.

Specified by:

dynamicQuery in interface DLFolderLocalService

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 <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl.

Specified by:

dynamicQuery in interface DLFolderLocalService

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 long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface DLFolderLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface DLFolderLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchDLFolder

public DLFolder fetchDLFolder(long folderId)

Specified by:

fetchDLFolder in interface DLFolderLocalService

fetchDLFolderByUuidAndGroupId

public DLFolder fetchDLFolderByUuidAndGroupId(String uuid,
                                              long groupId)

Returns the document library folder matching the UUID and group.

Specified by:

fetchDLFolderByUuidAndGroupId in interface DLFolderLocalService

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 DLFolder fetchFolder(long folderId)

Specified by:

fetchFolder in interface DLFolderLocalService

fetchFolder

public DLFolder fetchFolder(long groupId,
                            long parentFolderId,
                            String name)

Specified by:

fetchFolder in interface DLFolderLocalService

fetchFolder

public DLFolder fetchFolder(String uuid,
                            long groupId)

Specified by:

fetchFolder in interface DLFolderLocalService

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface DLFolderLocalService

getCompanyFolders

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

Specified by:

getCompanyFolders in interface DLFolderLocalService

getCompanyFoldersCount

public int getCompanyFoldersCount(long companyId)

Specified by:

getCompanyFoldersCount in interface DLFolderLocalService

getDLFileEntryTypeDLFolders

public List<DLFolder> getDLFileEntryTypeDLFolders(long fileEntryTypeId)

Specified by:

getDLFileEntryTypeDLFolders in interface DLFolderLocalService

getDLFileEntryTypeDLFolders

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

Specified by:

getDLFileEntryTypeDLFolders in interface DLFolderLocalService

getDLFileEntryTypeDLFolders

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

Specified by:

getDLFileEntryTypeDLFolders in interface DLFolderLocalService

getDLFileEntryTypeDLFoldersCount

public int getDLFileEntryTypeDLFoldersCount(long fileEntryTypeId)

Specified by:

getDLFileEntryTypeDLFoldersCount in interface DLFolderLocalService

getDLFileEntryTypePrimaryKeys

public long[] getDLFileEntryTypePrimaryKeys(long folderId)

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

Specified by:

getDLFileEntryTypePrimaryKeys in interface DLFolderLocalService

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 DLFolder getDLFolder(long folderId)
                     throws PortalException

Returns the document library folder with the primary key.

Specified by:

getDLFolder in interface DLFolderLocalService

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 DLFolder getDLFolderByUuidAndGroupId(String uuid,
                                            long groupId)
                                     throws PortalException

Returns the document library folder matching the UUID and group.

Specified by:

getDLFolderByUuidAndGroupId in interface DLFolderLocalService

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 List<DLFolder> getDLFolders(int start,
                                   int end)

Returns a range of all the document library folders.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl.

Specified by:

getDLFolders in interface DLFolderLocalService

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 List<DLFolder> getDLFoldersByUuidAndCompanyId(String uuid,
                                                     long companyId)

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

Specified by:

getDLFoldersByUuidAndCompanyId in interface DLFolderLocalService

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

Specified by:

getDLFoldersByUuidAndCompanyId in interface DLFolderLocalService

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

Returns the number of document library folders.

Specified by:

getDLFoldersCount in interface DLFolderLocalService

Returns:

the number of document library folders

getExportActionableDynamicQuery

public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

Specified by:

getExportActionableDynamicQuery in interface DLFolderLocalService

getFileEntriesAndFileShortcuts

public List<Object> getFileEntriesAndFileShortcuts(long groupId,
                                                   long folderId,
                                                   QueryDefinition<?> queryDefinition)

Specified by:

getFileEntriesAndFileShortcuts in interface DLFolderLocalService

getFileEntriesAndFileShortcutsCount

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

Specified by:

getFileEntriesAndFileShortcutsCount in interface DLFolderLocalService

getFolder

public DLFolder getFolder(long folderId)
                   throws PortalException

Specified by:

getFolder in interface DLFolderLocalService

Throws:

PortalException

getFolder

public DLFolder getFolder(long groupId,
                          long parentFolderId,
                          String name)
                   throws PortalException

Specified by:

getFolder in interface DLFolderLocalService

Throws:

PortalException

getFolderId

public long getFolderId(long companyId,
                        long folderId)

Specified by:

getFolderId in interface DLFolderLocalService

getFolders

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

Specified by:

getFolders in interface DLFolderLocalService

getFolders

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

Specified by:

getFolders in interface DLFolderLocalService

getFolders

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

Specified by:

getFolders in interface DLFolderLocalService

getFolders

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

Specified by:

getFolders in interface DLFolderLocalService

getFolders

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

Specified by:

getFolders in interface DLFolderLocalService

getFoldersAndFileEntriesAndFileShortcuts

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

Specified by:

getFoldersAndFileEntriesAndFileShortcuts in interface DLFolderLocalService

getFoldersAndFileEntriesAndFileShortcutsCount

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

Specified by:

getFoldersAndFileEntriesAndFileShortcutsCount in interface DLFolderLocalService

getFoldersCount

public int getFoldersCount(long groupId,
                           long parentFolderId)

Specified by:

getFoldersCount in interface DLFolderLocalService

getFoldersCount

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

Specified by:

getFoldersCount in interface DLFolderLocalService

getFoldersCount

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

Specified by:

getFoldersCount in interface DLFolderLocalService

getFoldersCount

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

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

Specified by:

getFoldersCount in interface DLFolderLocalService

getGroupFolderIds

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

Specified by:

getGroupFolderIds in interface DLFolderLocalService

getGroupSubfolderIds

public void getGroupSubfolderIds(List<Long> folderIds,
                                 long groupId,
                                 long folderId)

Specified by:

getGroupSubfolderIds in interface DLFolderLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface DLFolderLocalService

getMountFolder

public DLFolder getMountFolder(long repositoryId)
                        throws PortalException

Specified by:

getMountFolder in interface DLFolderLocalService

Throws:

PortalException

getMountFolders

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

Specified by:

getMountFolders in interface DLFolderLocalService

getMountFoldersCount

public int getMountFoldersCount(long groupId,
                                long parentFolderId)

Specified by:

getMountFoldersCount in interface DLFolderLocalService

getNoAssetFolders

public List<DLFolder> getNoAssetFolders()

Specified by:

getNoAssetFolders in interface DLFolderLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface DLFolderLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface DLFolderLocalService

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getRepositoryFolderIds

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

Specified by:

getRepositoryFolderIds in interface DLFolderLocalService

getRepositoryFolders

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

Specified by:

getRepositoryFolders in interface DLFolderLocalService

getRepositoryFoldersCount

public int getRepositoryFoldersCount(long repositoryId)

Specified by:

getRepositoryFoldersCount in interface DLFolderLocalService

getRepositorySubfolderIds

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

Specified by:

getRepositorySubfolderIds in interface DLFolderLocalService

getUniqueFolderName

public String getUniqueFolderName(String uuid,
                                  long groupId,
                                  long parentFolderId,
                                  String name,
                                  int count)

Specified by:

getUniqueFolderName in interface DLFolderLocalService

hasDLFileEntryTypeDLFolder

public boolean hasDLFileEntryTypeDLFolder(long fileEntryTypeId,
                                          long folderId)

Specified by:

hasDLFileEntryTypeDLFolder in interface DLFolderLocalService

hasDLFileEntryTypeDLFolders

public boolean hasDLFileEntryTypeDLFolders(long fileEntryTypeId)

Specified by:

hasDLFileEntryTypeDLFolders in interface DLFolderLocalService

hasFolderLock

public boolean hasFolderLock(long userId,
                             long folderId)

Specified by:

hasFolderLock in interface DLFolderLocalService

hasInheritableLock

public boolean hasInheritableLock(long folderId)

Specified by:

hasInheritableLock in interface DLFolderLocalService

lockFolder

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

Specified by:

lockFolder in interface DLFolderLocalService

Throws:

PortalException

lockFolder

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

Specified by:

lockFolder in interface DLFolderLocalService

Throws:

PortalException

moveFolder

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

Specified by:

moveFolder in interface DLFolderLocalService

Throws:

PortalException

rebuildTree

public void rebuildTree(long companyId)
                 throws PortalException

Specified by:

rebuildTree in interface DLFolderLocalService

Throws:

PortalException

rebuildTree

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

Specified by:

rebuildTree in interface DLFolderLocalService

Throws:

PortalException

setDLFileEntryTypeDLFolders

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

Specified by:

setDLFileEntryTypeDLFolders in interface DLFolderLocalService

unlockFolder

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

Specified by:

unlockFolder in interface DLFolderLocalService

Throws:

PortalException

unlockFolder

public void unlockFolder(long folderId,
                         String lockUuid)
                  throws PortalException

Specified by:

unlockFolder in interface DLFolderLocalService

Throws:

PortalException

updateDLFolder

public DLFolder updateDLFolder(DLFolder dlFolder)

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

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

Specified by:

updateDLFolder in interface DLFolderLocalService

Parameters:

dlFolder - the document library folder

Returns:

the document library folder that was updated

updateFolder

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

Specified by:

updateFolder in interface DLFolderLocalService

Throws:

PortalException

updateFolder

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

Specified by:

updateFolder in interface DLFolderLocalService

Throws:

PortalException

updateFolderAndFileEntryTypes

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

Specified by:

updateFolderAndFileEntryTypes in interface DLFolderLocalService

Throws:

PortalException

updateLastPostDate

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

Specified by:

updateLastPostDate in interface DLFolderLocalService

Throws:

PortalException

updateStatus

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

Specified by:

updateStatus in interface DLFolderLocalService

Throws:

PortalException

verifyInheritableLock

public boolean verifyInheritableLock(long folderId,
                                     String lockUuid)
                              throws PortalException

Specified by:

verifyInheritableLock in interface DLFolderLocalService

Throws:

PortalException

getCTPersistence

public CTPersistence<DLFolder> getCTPersistence()

Specified by:

getCTPersistence in interface DLFolderLocalService

Specified by:

getCTPersistence in interface CTService<DLFolder>

getModelClass

public Class<DLFolder> getModelClass()

Specified by:

getModelClass in interface DLFolderLocalService

Specified by:

getModelClass in interface CTService<DLFolder>

updateWithUnsafeFunction

public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFolder>,R,E> updateUnsafeFunction)
                                                   throws E extends Throwable

Specified by:

updateWithUnsafeFunction in interface DLFolderLocalService

Specified by:

updateWithUnsafeFunction in interface CTService<DLFolder>

Throws:

E extends Throwable

getWrappedService

public DLFolderLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<DLFolderLocalService>

setWrappedService

public void setWrappedService(DLFolderLocalService dlFolderLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<DLFolderLocalService>