com.liferay.document.library.kernel.service

Class DLFileEntryLocalServiceWrapper

Object

com.liferay.document.library.kernel.service.DLFileEntryLocalServiceWrapper

All Implemented Interfaces:

DLFileEntryLocalService, BaseLocalService, CTService<DLFileEntry>, PersistedModelLocalService, ServiceWrapper<DLFileEntryLocalService>

public class DLFileEntryLocalServiceWrapper
extends Object
implements DLFileEntryLocalService, ServiceWrapper<DLFileEntryLocalService>

Provides a wrapper for DLFileEntryLocalService.

Author:

Brian Wing Shun Chan

See Also:

DLFileEntryLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFileEntryLocalServiceWrapper()
DLFileEntryLocalServiceWrapper(DLFileEntryLocalService dlFileEntryLocalService)

Method Summary

Modifier and Type	Method and Description
DLFileEntry	addDLFileEntry(DLFileEntry dlFileEntry) Adds the document library file entry to the database.
DLFileEntry	addFileEntry(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)
DLFileVersion	cancelCheckOut(long userId, long fileEntryId)
void	checkFileEntries(long checkInterval)
void	checkInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext)
void	checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext)
DLFileEntry	checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext)
DLFileEntry	checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext)
DLFileEntry	checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext)
DLFileEntry	checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
void	convertExtraSettings(String[] keys)
DLFileEntry	copyFileEntry(long userId, long groupId, long repositoryId, long fileEntryId, long destFolderId, String fileName, ServiceContext serviceContext)
void	copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long fromFileVersionId, long toFileVersionId, ServiceContext serviceContext)
DLFileEntry	createDLFileEntry(long fileEntryId) Creates a new document library file entry with the primary key.
PersistedModel	createPersistedModel(Serializable primaryKeyObj)
DLFileEntry	deleteDLFileEntry(DLFileEntry dlFileEntry) Deletes the document library file entry from the database.
DLFileEntry	deleteDLFileEntry(long fileEntryId) Deletes the document library file entry with the primary key from the database.
void	deleteFileEntries(long groupId, long folderId)
void	deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries)
DLFileEntry	deleteFileEntry(DLFileEntry dlFileEntry)
DLFileEntry	deleteFileEntry(long fileEntryId)
DLFileEntry	deleteFileEntry(long userId, long fileEntryId)
DLFileEntry	deleteFileVersion(long userId, long fileEntryId, String version)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteRepositoryFileEntries(long repositoryId)
void	deleteRepositoryFileEntries(long repositoryId, long folderId)
void	deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries)
<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.
DLFileEntry	fetchDLFileEntry(long fileEntryId)
DLFileEntry	fetchDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
DLFileEntry	fetchDLFileEntryByUuidAndGroupId(String uuid, long groupId) Returns the document library file entry matching the UUID and group.
DLFileEntry	fetchFileEntry(long groupId, long folderId, String title)
DLFileEntry	fetchFileEntry(String uuid, long groupId)
DLFileEntry	fetchFileEntryByAnyImageId(long imageId)
DLFileEntry	fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
DLFileEntry	fetchFileEntryByFileName(long groupId, long folderId, String fileName)
DLFileEntry	fetchFileEntryByName(long groupId, long folderId, String name)
ActionableDynamicQuery	getActionableDynamicQuery()
CTPersistence<DLFileEntry>	getCTPersistence()
List<DLFileEntry>	getDDMStructureFileEntries(long[] ddmStructureIds)
List<DLFileEntry>	getDDMStructureFileEntries(long groupId, long[] ddmStructureIds)
List<DLFileEntry>	getDLFileEntries(int start, int end) Returns a range of all the document library file entries.
List<DLFileEntry>	getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId) Returns all the document library file entries matching the UUID and company.
List<DLFileEntry>	getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) Returns a range of document library file entries matching the UUID and company.
int	getDLFileEntriesCount() Returns the number of document library file entries.
DLFileEntry	getDLFileEntry(long fileEntryId) Returns the document library file entry with the primary key.
DLFileEntry	getDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId)
DLFileEntry	getDLFileEntryByUuidAndGroupId(String uuid, long groupId) Returns the document library file entry matching the UUID and group.
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
List<DLFileEntry>	getExtraSettingsFileEntries(int start, int end)
int	getExtraSettingsFileEntriesCount()
InputStream	getFileAsStream(long fileEntryId, String version)
InputStream	getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
InputStream	getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment)
List<DLFileEntry>	getFileEntries(int start, int end)
List<DLFileEntry>	getFileEntries(long groupId, long folderId)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
List<DLFileEntry>	getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
List<DLFileEntry>	getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
List<DLFileEntry>	getFileEntries(long folderId, String name)
List<DLFileEntry>	getFileEntriesByClassNameIdAndTreePath(long classNameId, String treePath)
int	getFileEntriesCount()
int	getFileEntriesCount(long groupId, long folderId)
int	getFileEntriesCount(long groupId, long folderId, int status)
int	getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
int	getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
DLFileEntry	getFileEntry(long fileEntryId)
DLFileEntry	getFileEntry(long groupId, long folderId, String title)
DLFileEntry	getFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
DLFileEntry	getFileEntryByFileName(long groupId, long folderId, String fileName)
DLFileEntry	getFileEntryByName(long groupId, long folderId, String name)
DLFileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId)
List<DLFileEntry>	getGroupFileEntries(long groupId, int start, int end)
List<DLFileEntry>	getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, int start, int end)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
List<DLFileEntry>	getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
int	getGroupFileEntriesCount(long groupId)
int	getGroupFileEntriesCount(long groupId, long userId)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
Class<DLFileEntry>	getModelClass()
List<DLFileEntry>	getNoAssetFileEntries()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<DLFileEntry>	getRepositoryFileEntries(long repositoryId, int start, int end)
int	getRepositoryFileEntriesCount(long repositoryId)
String	getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension)
DLFileEntryLocalService	getWrappedService()
boolean	hasExtraSettings()
boolean	hasFileEntryLock(long userId, long fileEntryId)
boolean	hasFileEntryLock(long userId, long fileEntryId, long folderId)
void	incrementViewCounter(DLFileEntry dlFileEntry, int increment)
boolean	isFileEntryCheckedOut(long fileEntryId)
Lock	lockFileEntry(long userId, long fileEntryId)
DLFileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext)
void	rebuildTree(long companyId)
void	revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext)
Hits	search(long groupId, long userId, long creatorUserId, int status, int start, int end)
Hits	search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
void	setTreePaths(long folderId, String treePath, boolean reindex)
void	setWrappedService(DLFileEntryLocalService dlFileEntryLocalService)
void	unlockFileEntry(long fileEntryId)
DLFileEntry	updateDLFileEntry(DLFileEntry dlFileEntry) Updates the document library file entry in the database or adds it if it does not yet exist.
DLFileEntry	updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext)
DLFileEntry	updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext)
DLFileEntry	updateStatus(long userId, DLFileEntry dlFileEntry, DLFileVersion dlFileVersion, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
DLFileEntry	updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
<R,E extends Throwable> R	updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntry>,R,E> updateUnsafeFunction)
void	validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title)
boolean	verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
boolean	verifyFileEntryLock(long fileEntryId, 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

DLFileEntryLocalServiceWrapper

public DLFileEntryLocalServiceWrapper()

DLFileEntryLocalServiceWrapper

public DLFileEntryLocalServiceWrapper(DLFileEntryLocalService dlFileEntryLocalService)

Method Detail

addDLFileEntry

public DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)

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

Important: Inspect DLFileEntryLocalServiceImpl 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:

addDLFileEntry in interface DLFileEntryLocalService

Parameters:

dlFileEntry - the document library file entry

Returns:

the document library file entry that was added

addFileEntry

public DLFileEntry addFileEntry(String externalReferenceCode,
                                long userId,
                                long groupId,
                                long repositoryId,
                                long folderId,
                                String sourceFileName,
                                String mimeType,
                                String title,
                                String urlTitle,
                                String description,
                                String changeLog,
                                long fileEntryTypeId,
                                Map<String,DDMFormValues> ddmFormValuesMap,
                                File file,
                                InputStream inputStream,
                                long size,
                                Date expirationDate,
                                Date reviewDate,
                                ServiceContext serviceContext)
                         throws PortalException

Specified by:

addFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

cancelCheckOut

public DLFileVersion cancelCheckOut(long userId,
                                    long fileEntryId)
                             throws PortalException

Specified by:

cancelCheckOut in interface DLFileEntryLocalService

Throws:

PortalException

checkFileEntries

public void checkFileEntries(long checkInterval)
                      throws PortalException

Specified by:

checkFileEntries in interface DLFileEntryLocalService

Throws:

PortalException

checkInFileEntry

public void checkInFileEntry(long userId,
                             long fileEntryId,
                             DLVersionNumberIncrease dlVersionNumberIncrease,
                             String changeLog,
                             ServiceContext serviceContext)
                      throws PortalException

Specified by:

checkInFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

checkInFileEntry

public void checkInFileEntry(long userId,
                             long fileEntryId,
                             String lockUuid,
                             ServiceContext serviceContext)
                      throws PortalException

Specified by:

checkInFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long userId,
                                     long fileEntryId,
                                     long fileEntryTypeId,
                                     ServiceContext serviceContext)
                              throws PortalException

Specified by:

checkOutFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long userId,
                                     long fileEntryId,
                                     long fileEntryTypeId,
                                     String owner,
                                     long expirationTime,
                                     ServiceContext serviceContext)
                              throws PortalException

Specified by:

checkOutFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long userId,
                                     long fileEntryId,
                                     ServiceContext serviceContext)
                              throws PortalException

Specified by:

checkOutFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long userId,
                                     long fileEntryId,
                                     String owner,
                                     long expirationTime,
                                     ServiceContext serviceContext)
                              throws PortalException

Specified by:

checkOutFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

convertExtraSettings

public void convertExtraSettings(String[] keys)
                          throws PortalException

Specified by:

convertExtraSettings in interface DLFileEntryLocalService

Throws:

PortalException

copyFileEntry

public DLFileEntry copyFileEntry(long userId,
                                 long groupId,
                                 long repositoryId,
                                 long fileEntryId,
                                 long destFolderId,
                                 String fileName,
                                 ServiceContext serviceContext)
                          throws PortalException

Specified by:

copyFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

copyFileEntryMetadata

public void copyFileEntryMetadata(long companyId,
                                  long fileEntryTypeId,
                                  long fileEntryId,
                                  long fromFileVersionId,
                                  long toFileVersionId,
                                  ServiceContext serviceContext)
                           throws PortalException

Specified by:

copyFileEntryMetadata in interface DLFileEntryLocalService

Throws:

PortalException

createDLFileEntry

public DLFileEntry createDLFileEntry(long fileEntryId)

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

Specified by:

createDLFileEntry in interface DLFileEntryLocalService

Parameters:

fileEntryId - the primary key for the new document library file entry

Returns:

the new document library file entry

createPersistedModel

public PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                    throws PortalException

Specified by:

createPersistedModel in interface DLFileEntryLocalService

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteDLFileEntry

public DLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry)

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

Important: Inspect DLFileEntryLocalServiceImpl 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:

deleteDLFileEntry in interface DLFileEntryLocalService

Parameters:

dlFileEntry - the document library file entry

Returns:

the document library file entry that was removed

deleteDLFileEntry

public DLFileEntry deleteDLFileEntry(long fileEntryId)
                              throws PortalException

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

Important: Inspect DLFileEntryLocalServiceImpl 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:

deleteDLFileEntry in interface DLFileEntryLocalService

Parameters:

fileEntryId - the primary key of the document library file entry

Returns:

the document library file entry that was removed

Throws:

PortalException - if a document library file entry with the primary key could not be found

deleteFileEntries

public void deleteFileEntries(long groupId,
                              long folderId)
                       throws PortalException

Specified by:

deleteFileEntries in interface DLFileEntryLocalService

Throws:

PortalException

deleteFileEntries

public void deleteFileEntries(long groupId,
                              long folderId,
                              boolean includeTrashedEntries)
                       throws PortalException

Specified by:

deleteFileEntries in interface DLFileEntryLocalService

Throws:

PortalException

deleteFileEntry

public DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry)
                            throws PortalException

Specified by:

deleteFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

deleteFileEntry

public DLFileEntry deleteFileEntry(long fileEntryId)
                            throws PortalException

Specified by:

deleteFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

deleteFileEntry

public DLFileEntry deleteFileEntry(long userId,
                                   long fileEntryId)
                            throws PortalException

Specified by:

deleteFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

deleteFileVersion

public DLFileEntry deleteFileVersion(long userId,
                                     long fileEntryId,
                                     String version)
                              throws PortalException

Specified by:

deleteFileVersion in interface DLFileEntryLocalService

Throws:

PortalException

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface DLFileEntryLocalService

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteRepositoryFileEntries

public void deleteRepositoryFileEntries(long repositoryId)
                                 throws PortalException

Specified by:

deleteRepositoryFileEntries in interface DLFileEntryLocalService

Throws:

PortalException

deleteRepositoryFileEntries

public void deleteRepositoryFileEntries(long repositoryId,
                                        long folderId)
                                 throws PortalException

Specified by:

deleteRepositoryFileEntries in interface DLFileEntryLocalService

Throws:

PortalException

deleteRepositoryFileEntries

public void deleteRepositoryFileEntries(long repositoryId,
                                        long folderId,
                                        boolean includeTrashedEntries)
                                 throws PortalException

Specified by:

deleteRepositoryFileEntries in interface DLFileEntryLocalService

Throws:

PortalException

dslQuery

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

Specified by:

dslQuery in interface DLFileEntryLocalService

Specified by:

dslQuery in interface PersistedModelLocalService

dslQueryCount

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

Specified by:

dslQueryCount in interface DLFileEntryLocalService

Specified by:

dslQueryCount in interface PersistedModelLocalService

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface DLFileEntryLocalService

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 DLFileEntryLocalService

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

Specified by:

dynamicQuery in interface DLFileEntryLocalService

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

Specified by:

dynamicQuery in interface DLFileEntryLocalService

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 DLFileEntryLocalService

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 DLFileEntryLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchDLFileEntry

public DLFileEntry fetchDLFileEntry(long fileEntryId)

Specified by:

fetchDLFileEntry in interface DLFileEntryLocalService

fetchDLFileEntryByExternalReferenceCode

public DLFileEntry fetchDLFileEntryByExternalReferenceCode(String externalReferenceCode,
                                                           long groupId)

Specified by:

fetchDLFileEntryByExternalReferenceCode in interface DLFileEntryLocalService

fetchDLFileEntryByUuidAndGroupId

public DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid,
                                                    long groupId)

Returns the document library file entry matching the UUID and group.

Specified by:

fetchDLFileEntryByUuidAndGroupId in interface DLFileEntryLocalService

Parameters:

uuid - the document library file entry's UUID

groupId - the primary key of the group

Returns:

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

fetchFileEntry

public DLFileEntry fetchFileEntry(long groupId,
                                  long folderId,
                                  String title)

Specified by:

fetchFileEntry in interface DLFileEntryLocalService

fetchFileEntry

public DLFileEntry fetchFileEntry(String uuid,
                                  long groupId)

Specified by:

fetchFileEntry in interface DLFileEntryLocalService

fetchFileEntryByAnyImageId

public DLFileEntry fetchFileEntryByAnyImageId(long imageId)

Specified by:

fetchFileEntryByAnyImageId in interface DLFileEntryLocalService

fetchFileEntryByExternalReferenceCode

public DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId,
                                                         String externalReferenceCode)

Specified by:

fetchFileEntryByExternalReferenceCode in interface DLFileEntryLocalService

fetchFileEntryByFileName

public DLFileEntry fetchFileEntryByFileName(long groupId,
                                            long folderId,
                                            String fileName)

Specified by:

fetchFileEntryByFileName in interface DLFileEntryLocalService

fetchFileEntryByName

public DLFileEntry fetchFileEntryByName(long groupId,
                                        long folderId,
                                        String name)

Specified by:

fetchFileEntryByName in interface DLFileEntryLocalService

getActionableDynamicQuery

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface DLFileEntryLocalService

getDDMStructureFileEntries

public List<DLFileEntry> getDDMStructureFileEntries(long groupId,
                                                    long[] ddmStructureIds)

Specified by:

getDDMStructureFileEntries in interface DLFileEntryLocalService

getDDMStructureFileEntries

public List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)

Specified by:

getDDMStructureFileEntries in interface DLFileEntryLocalService

getDLFileEntries

public List<DLFileEntry> getDLFileEntries(int start,
                                          int end)

Returns a range of all the document library file entries.

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

Specified by:

getDLFileEntries in interface DLFileEntryLocalService

Parameters:

start - the lower bound of the range of document library file entries

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

Returns:

the range of document library file entries

getDLFileEntriesByUuidAndCompanyId

public List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid,
                                                            long companyId)

Returns all the document library file entries matching the UUID and company.

Specified by:

getDLFileEntriesByUuidAndCompanyId in interface DLFileEntryLocalService

Parameters:

uuid - the UUID of the document library file entries

companyId - the primary key of the company

Returns:

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

getDLFileEntriesByUuidAndCompanyId

public List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid,
                                                            long companyId,
                                                            int start,
                                                            int end,
                                                            OrderByComparator<DLFileEntry> orderByComparator)

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

Specified by:

getDLFileEntriesByUuidAndCompanyId in interface DLFileEntryLocalService

Parameters:

uuid - the UUID of the document library file entries

companyId - the primary key of the company

start - the lower bound of the range of document library file entries

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

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

Returns:

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

getDLFileEntriesCount

public int getDLFileEntriesCount()

Returns the number of document library file entries.

Specified by:

getDLFileEntriesCount in interface DLFileEntryLocalService

Returns:

the number of document library file entries

getDLFileEntry

public DLFileEntry getDLFileEntry(long fileEntryId)
                           throws PortalException

Returns the document library file entry with the primary key.

Specified by:

getDLFileEntry in interface DLFileEntryLocalService

Parameters:

fileEntryId - the primary key of the document library file entry

Returns:

the document library file entry

Throws:

PortalException - if a document library file entry with the primary key could not be found

getDLFileEntryByExternalReferenceCode

public DLFileEntry getDLFileEntryByExternalReferenceCode(String externalReferenceCode,
                                                         long groupId)
                                                  throws PortalException

Specified by:

getDLFileEntryByExternalReferenceCode in interface DLFileEntryLocalService

Throws:

PortalException

getDLFileEntryByUuidAndGroupId

public DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid,
                                                  long groupId)
                                           throws PortalException

Returns the document library file entry matching the UUID and group.

Specified by:

getDLFileEntryByUuidAndGroupId in interface DLFileEntryLocalService

Parameters:

uuid - the document library file entry's UUID

groupId - the primary key of the group

Returns:

the matching document library file entry

Throws:

PortalException - if a matching document library file entry could not be found

getExportActionableDynamicQuery

public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

Specified by:

getExportActionableDynamicQuery in interface DLFileEntryLocalService

getExtraSettingsFileEntries

public List<DLFileEntry> getExtraSettingsFileEntries(int start,
                                                     int end)

Specified by:

getExtraSettingsFileEntries in interface DLFileEntryLocalService

getExtraSettingsFileEntriesCount

public int getExtraSettingsFileEntriesCount()

Specified by:

getExtraSettingsFileEntriesCount in interface DLFileEntryLocalService

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version)
                            throws PortalException

Specified by:

getFileAsStream in interface DLFileEntryLocalService

Throws:

PortalException

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version,
                                   boolean incrementCounter)
                            throws PortalException

Specified by:

getFileAsStream in interface DLFileEntryLocalService

Throws:

PortalException

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version,
                                   boolean incrementCounter,
                                   int increment)
                            throws PortalException

Specified by:

getFileAsStream in interface DLFileEntryLocalService

Throws:

PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(int start,
                                        int end)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        int status,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> orderByComparator)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> orderByComparator)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long userId,
                                        List<Long> repositoryIds,
                                        List<Long> folderIds,
                                        String[] mimeTypes,
                                        QueryDefinition<DLFileEntry> queryDefinition)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long userId,
                                        List<Long> folderIds,
                                        String[] mimeTypes,
                                        QueryDefinition<DLFileEntry> queryDefinition)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntries

public List<DLFileEntry> getFileEntries(long folderId,
                                        String name)

Specified by:

getFileEntries in interface DLFileEntryLocalService

getFileEntriesByClassNameIdAndTreePath

public List<DLFileEntry> getFileEntriesByClassNameIdAndTreePath(long classNameId,
                                                                String treePath)

Specified by:

getFileEntriesByClassNameIdAndTreePath in interface DLFileEntryLocalService

getFileEntriesCount

public int getFileEntriesCount()

Specified by:

getFileEntriesCount in interface DLFileEntryLocalService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId)

Specified by:

getFileEntriesCount in interface DLFileEntryLocalService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId,
                               int status)

Specified by:

getFileEntriesCount in interface DLFileEntryLocalService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long userId,
                               List<Long> repositoryIds,
                               List<Long> folderIds,
                               String[] mimeTypes,
                               QueryDefinition<DLFileEntry> queryDefinition)

Specified by:

getFileEntriesCount in interface DLFileEntryLocalService

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long userId,
                               List<Long> folderIds,
                               String[] mimeTypes,
                               QueryDefinition<DLFileEntry> queryDefinition)

Specified by:

getFileEntriesCount in interface DLFileEntryLocalService

getFileEntry

public DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException

Specified by:

getFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

getFileEntry

public DLFileEntry getFileEntry(long groupId,
                                long folderId,
                                String title)
                         throws PortalException

Specified by:

getFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

getFileEntryByExternalReferenceCode

public DLFileEntry getFileEntryByExternalReferenceCode(long groupId,
                                                       String externalReferenceCode)
                                                throws PortalException

Specified by:

getFileEntryByExternalReferenceCode in interface DLFileEntryLocalService

Throws:

PortalException

getFileEntryByFileName

public DLFileEntry getFileEntryByFileName(long groupId,
                                          long folderId,
                                          String fileName)
                                   throws PortalException

Specified by:

getFileEntryByFileName in interface DLFileEntryLocalService

Throws:

PortalException

getFileEntryByName

public DLFileEntry getFileEntryByName(long groupId,
                                      long folderId,
                                      String name)
                               throws PortalException

Specified by:

getFileEntryByName in interface DLFileEntryLocalService

Throws:

PortalException

getFileEntryByUuidAndGroupId

public DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                long groupId)
                                         throws PortalException

Specified by:

getFileEntryByUuidAndGroupId in interface DLFileEntryLocalService

Throws:

PortalException

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             int start,
                                             int end)

Specified by:

getGroupFileEntries in interface DLFileEntryLocalService

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> orderByComparator)

Specified by:

getGroupFileEntries in interface DLFileEntryLocalService

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             int start,
                                             int end)

Specified by:

getGroupFileEntries in interface DLFileEntryLocalService

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> orderByComparator)

Specified by:

getGroupFileEntries in interface DLFileEntryLocalService

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long rootFolderId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> orderByComparator)

Specified by:

getGroupFileEntries in interface DLFileEntryLocalService

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long repositoryId,
                                             long rootFolderId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> orderByComparator)

Specified by:

getGroupFileEntries in interface DLFileEntryLocalService

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId)

Specified by:

getGroupFileEntriesCount in interface DLFileEntryLocalService

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId)

Specified by:

getGroupFileEntriesCount in interface DLFileEntryLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface DLFileEntryLocalService

getNoAssetFileEntries

public List<DLFileEntry> getNoAssetFileEntries()

Specified by:

getNoAssetFileEntries in interface DLFileEntryLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface DLFileEntryLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface DLFileEntryLocalService

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getRepositoryFileEntries

public List<DLFileEntry> getRepositoryFileEntries(long repositoryId,
                                                  int start,
                                                  int end)

Specified by:

getRepositoryFileEntries in interface DLFileEntryLocalService

getRepositoryFileEntriesCount

public int getRepositoryFileEntriesCount(long repositoryId)

Specified by:

getRepositoryFileEntriesCount in interface DLFileEntryLocalService

getUniqueTitle

public String getUniqueTitle(long groupId,
                             long folderId,
                             long fileEntryId,
                             String title,
                             String extension)
                      throws PortalException

Specified by:

getUniqueTitle in interface DLFileEntryLocalService

Throws:

PortalException

hasExtraSettings

public boolean hasExtraSettings()

Specified by:

hasExtraSettings in interface DLFileEntryLocalService

hasFileEntryLock

public boolean hasFileEntryLock(long userId,
                                long fileEntryId)
                         throws PortalException

Specified by:

hasFileEntryLock in interface DLFileEntryLocalService

Throws:

PortalException

hasFileEntryLock

public boolean hasFileEntryLock(long userId,
                                long fileEntryId,
                                long folderId)

Specified by:

hasFileEntryLock in interface DLFileEntryLocalService

incrementViewCounter

public void incrementViewCounter(DLFileEntry dlFileEntry,
                                 int increment)

Specified by:

incrementViewCounter in interface DLFileEntryLocalService

isFileEntryCheckedOut

public boolean isFileEntryCheckedOut(long fileEntryId)

Specified by:

isFileEntryCheckedOut in interface DLFileEntryLocalService

lockFileEntry

public Lock lockFileEntry(long userId,
                          long fileEntryId)
                   throws PortalException

Specified by:

lockFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

moveFileEntry

public DLFileEntry moveFileEntry(long userId,
                                 long fileEntryId,
                                 long newFolderId,
                                 ServiceContext serviceContext)
                          throws PortalException

Specified by:

moveFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

rebuildTree

public void rebuildTree(long companyId)
                 throws PortalException

Specified by:

rebuildTree in interface DLFileEntryLocalService

Throws:

PortalException

revertFileEntry

public void revertFileEntry(long userId,
                            long fileEntryId,
                            String version,
                            ServiceContext serviceContext)
                     throws PortalException

Specified by:

revertFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

search

public Hits search(long groupId,
                   long userId,
                   long creatorUserId,
                   int status,
                   int start,
                   int end)
            throws PortalException

Specified by:

search in interface DLFileEntryLocalService

Throws:

PortalException

search

public Hits search(long groupId,
                   long userId,
                   long creatorUserId,
                   long folderId,
                   String[] mimeTypes,
                   int status,
                   int start,
                   int end)
            throws PortalException

Specified by:

search in interface DLFileEntryLocalService

Throws:

PortalException

setTreePaths

public void setTreePaths(long folderId,
                         String treePath,
                         boolean reindex)
                  throws PortalException

Specified by:

setTreePaths in interface DLFileEntryLocalService

Throws:

PortalException

unlockFileEntry

public void unlockFileEntry(long fileEntryId)

Specified by:

unlockFileEntry in interface DLFileEntryLocalService

updateDLFileEntry

public DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)

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

Important: Inspect DLFileEntryLocalServiceImpl 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:

updateDLFileEntry in interface DLFileEntryLocalService

Parameters:

dlFileEntry - the document library file entry

Returns:

the document library file entry that was updated

updateFileEntry

public DLFileEntry updateFileEntry(long userId,
                                   long fileEntryId,
                                   String sourceFileName,
                                   String mimeType,
                                   String title,
                                   String urlTitle,
                                   String description,
                                   String changeLog,
                                   DLVersionNumberIncrease dlVersionNumberIncrease,
                                   long fileEntryTypeId,
                                   Map<String,DDMFormValues> ddmFormValuesMap,
                                   File file,
                                   InputStream inputStream,
                                   long size,
                                   Date expirationDate,
                                   Date reviewDate,
                                   ServiceContext serviceContext)
                            throws PortalException

Specified by:

updateFileEntry in interface DLFileEntryLocalService

Throws:

PortalException

updateFileEntryType

public DLFileEntry updateFileEntryType(long userId,
                                       long fileEntryId,
                                       long fileEntryTypeId,
                                       ServiceContext serviceContext)
                                throws PortalException

Specified by:

updateFileEntryType in interface DLFileEntryLocalService

Throws:

PortalException

updateStatus

public DLFileEntry updateStatus(long userId,
                                DLFileEntry dlFileEntry,
                                DLFileVersion dlFileVersion,
                                int status,
                                ServiceContext serviceContext,
                                Map<String,Serializable> workflowContext)
                         throws PortalException

Specified by:

updateStatus in interface DLFileEntryLocalService

Throws:

PortalException

updateStatus

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

Specified by:

updateStatus in interface DLFileEntryLocalService

Throws:

PortalException

validateFile

public void validateFile(long groupId,
                         long folderId,
                         long fileEntryId,
                         String fileName,
                         String title)
                  throws PortalException

Specified by:

validateFile in interface DLFileEntryLocalService

Throws:

PortalException

verifyFileEntryCheckOut

public boolean verifyFileEntryCheckOut(long fileEntryId,
                                       String lockUuid)
                                throws PortalException

Specified by:

verifyFileEntryCheckOut in interface DLFileEntryLocalService

Throws:

PortalException

verifyFileEntryLock

public boolean verifyFileEntryLock(long fileEntryId,
                                   String lockUuid)
                            throws PortalException

Specified by:

verifyFileEntryLock in interface DLFileEntryLocalService

Throws:

PortalException

getCTPersistence

public CTPersistence<DLFileEntry> getCTPersistence()

Specified by:

getCTPersistence in interface DLFileEntryLocalService

Specified by:

getCTPersistence in interface CTService<DLFileEntry>

getModelClass

public Class<DLFileEntry> getModelClass()

Specified by:

getModelClass in interface DLFileEntryLocalService

Specified by:

getModelClass in interface CTService<DLFileEntry>

updateWithUnsafeFunction

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

Specified by:

updateWithUnsafeFunction in interface DLFileEntryLocalService

Specified by:

updateWithUnsafeFunction in interface CTService<DLFileEntry>

Throws:

E extends Throwable

getWrappedService

public DLFileEntryLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<DLFileEntryLocalService>

setWrappedService

public void setWrappedService(DLFileEntryLocalService dlFileEntryLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<DLFileEntryLocalService>