Class DLFileEntryLocalServiceWrapper
- All Implemented Interfaces:
DLFileEntryLocalService
,BaseLocalService
,CTService<DLFileEntry>
,PersistedModelLocalService
,ServiceWrapper<DLFileEntryLocalService>
DLFileEntryLocalService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
ConstructorsConstructorDescriptionDLFileEntryLocalServiceWrapper
(DLFileEntryLocalService dlFileEntryLocalService) -
Method Summary
Modifier and TypeMethodDescriptionaddDLFileEntry
(DLFileEntry dlFileEntry) Adds the document library file entry to the database.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 displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) cancelCheckOut
(long userId, long fileEntryId) void
checkFileEntries
(long companyId, long checkInterval) void
checkInFileEntry
(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) void
checkInFileEntry
(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) checkOutFileEntry
(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) checkOutFileEntry
(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) checkOutFileEntry
(long userId, long fileEntryId, ServiceContext serviceContext) checkOutFileEntry
(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) void
convertExtraSettings
(String[] keys) copyFileEntry
(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, ServiceContext serviceContext) void
copyFileEntryMetadata
(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, ServiceContext serviceContext) createDLFileEntry
(long fileEntryId) Creates a new document library file entry with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteDLFileEntry
(long fileEntryId) Deletes the document library file entry with the primary key from the database.deleteDLFileEntry
(DLFileEntry dlFileEntry) Deletes the document library file entry from the database.void
deleteFileEntries
(long groupId, long folderId) void
deleteFileEntries
(long groupId, long folderId, boolean includeTrashedEntries) deleteFileEntry
(long fileEntryId) deleteFileEntry
(long userId, long fileEntryId) deleteFileEntry
(DLFileEntry dlFileEntry) deleteFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) deleteFileVersion
(long userId, long fileEntryId, String version) 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) <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.fetchDLFileEntry
(long fileEntryId) fetchDLFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchDLFileEntryByUuidAndGroupId
(String uuid, long groupId) Returns the document library file entry matching the UUID and group.fetchFileEntry
(long groupId, long folderId, String title) fetchFileEntry
(String uuid, long groupId) fetchFileEntryByAnyImageId
(long imageId) fetchFileEntryByExternalReferenceCode
(long groupId, String externalReferenceCode) fetchFileEntryByFileName
(long groupId, long folderId, String fileName) fetchFileEntryByName
(long groupId, long folderId, String name) void
forEachFileEntry
(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) void
forEachFileEntry
(long companyId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) getDDMStructureFileEntries
(long[] ddmStructureIds) getDDMStructureFileEntries
(long groupId, long[] ddmStructureIds) getDLFileEntries
(int start, int end) Returns a range of all the document library file entries.getDLFileEntriesByUuidAndCompanyId
(String uuid, long companyId) Returns all the document library file entries matching the UUID and company.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
Returns the number of document library file entries.getDLFileEntry
(long fileEntryId) Returns the document library file entry with the primary key.getDLFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) getDLFileEntryByUuidAndGroupId
(String uuid, long groupId) Returns the document library file entry matching the UUID and group.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getExtraSettingsFileEntries
(int start, int end) int
getFileAsStream
(long fileEntryId, String version) getFileAsStream
(long fileEntryId, String version, boolean incrementCounter) getFileAsStream
(long fileEntryId, String version, boolean incrementCounter, int increment) getFileEntries
(int start, int end) getFileEntries
(long groupId, long folderId) getFileEntries
(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getFileEntries
(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getFileEntries
(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) getFileEntries
(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) getFileEntries
(long folderId, String name) getFileEntriesByClassNameIdAndTreePath
(long classNameId, String treePath) int
int
getFileEntriesCount
(long groupId, long folderId) int
getFileEntriesCount
(long groupId, long folderId, int status) int
getFileEntriesCount
(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) int
getFileEntriesCount
(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) getFileEntry
(long fileEntryId) getFileEntry
(long groupId, long folderId, String title) getFileEntryByExternalReferenceCode
(String externalReferenceCode, long groupId) getFileEntryByFileName
(long groupId, long folderId, String fileName) getFileEntryByName
(long groupId, long folderId, String name) getFileEntryByUuidAndGroupId
(String uuid, long groupId) getFileEntryTypeIds
(long companyId, long[] groupIds, String treePath) getGroupFileEntries
(long groupId, int start, int end) getGroupFileEntries
(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getGroupFileEntries
(long groupId, long userId, int start, int end) getGroupFileEntries
(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) getGroupFileEntries
(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) 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) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getRepositoryFileEntries
(long repositoryId, int start, int end) int
getRepositoryFileEntriesCount
(long repositoryId) getUniqueTitle
(long groupId, long folderId, long fileEntryId, String title, String extension) boolean
boolean
hasFileEntryLock
(long userId, long fileEntryId) boolean
hasFileEntryLock
(long userId, long fileEntryId, long folderId) void
incrementViewCounter
(DLFileEntry dlFileEntry, int increment) boolean
isFileEntryCheckedOut
(long fileEntryId) lockFileEntry
(long userId, long fileEntryId) moveFileEntry
(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) void
rebuildTree
(long companyId) void
revertFileEntry
(long userId, long fileEntryId, String version, ServiceContext serviceContext) search
(long groupId, long userId, long creatorUserId, int status, int start, int end) 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) updateDLFileEntry
(DLFileEntry dlFileEntry) Updates the document library file entry in the database or adds it if it does not yet exist.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 displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) updateFileEntryType
(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) updateStatus
(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) updateStatus
(long userId, DLFileEntry dlFileEntry, DLFileVersion dlFileVersion, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
DLFileEntryLocalServiceWrapper
public DLFileEntryLocalServiceWrapper() -
DLFileEntryLocalServiceWrapper
-
-
Method Details
-
addDLFileEntry
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 interfaceDLFileEntryLocalService
- 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 displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException- Specified by:
addFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
cancelCheckOut
- Specified by:
cancelCheckOut
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkFileEntries
- Specified by:
checkFileEntries
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkInFileEntry
public void checkInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException - Specified by:
checkInFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkInFileEntry
public void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException - Specified by:
checkInFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
convertExtraSettings
- Specified by:
convertExtraSettings
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
copyFileEntry
public DLFileEntry copyFileEntry(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, ServiceContext serviceContext) throws PortalException - Specified by:
copyFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
copyFileEntryMetadata
public void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, ServiceContext serviceContext) throws PortalException - Specified by:
copyFileEntryMetadata
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
createDLFileEntry
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 interfaceDLFileEntryLocalService
- Parameters:
fileEntryId
- the primary key for the new document library file entry- Returns:
- the new document library file entry
-
createPersistedModel
- Specified by:
createPersistedModel
in interfaceDLFileEntryLocalService
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
PortalException
-
deleteDLFileEntry
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 interfaceDLFileEntryLocalService
- Parameters:
dlFileEntry
- the document library file entry- Returns:
- the document library file entry that was removed
-
deleteDLFileEntry
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 interfaceDLFileEntryLocalService
- 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 foundPortalException
-
deleteFileEntries
- Specified by:
deleteFileEntries
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteFileEntries
public void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries) throws PortalException - Specified by:
deleteFileEntries
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteFileEntry
- Specified by:
deleteFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteFileEntry
- Specified by:
deleteFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteFileEntry
- Specified by:
deleteFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteFileEntryByExternalReferenceCode
public DLFileEntry deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
deleteFileEntryByExternalReferenceCode
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteFileVersion
public DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version) throws PortalException - Specified by:
deleteFileVersion
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfaceDLFileEntryLocalService
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
PortalException
-
deleteRepositoryFileEntries
- Specified by:
deleteRepositoryFileEntries
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteRepositoryFileEntries
- Specified by:
deleteRepositoryFileEntries
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
deleteRepositoryFileEntries
public void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) throws PortalException - Specified by:
deleteRepositoryFileEntries
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfaceDLFileEntryLocalService
- Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfaceDLFileEntryLocalService
- Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
- Specified by:
dynamicQuery
in interfaceDLFileEntryLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in interfaceDLFileEntryLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.- Specified by:
dynamicQuery
in interfaceDLFileEntryLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.- Specified by:
dynamicQuery
in interfaceDLFileEntryLocalService
- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceDLFileEntryLocalService
- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCount
in interfaceDLFileEntryLocalService
- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDLFileEntry
- Specified by:
fetchDLFileEntry
in interfaceDLFileEntryLocalService
-
fetchDLFileEntryByExternalReferenceCode
public DLFileEntry fetchDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) - Specified by:
fetchDLFileEntryByExternalReferenceCode
in interfaceDLFileEntryLocalService
-
fetchDLFileEntryByUuidAndGroupId
Returns the document library file entry matching the UUID and group.- Specified by:
fetchDLFileEntryByUuidAndGroupId
in interfaceDLFileEntryLocalService
- Parameters:
uuid
- the document library file entry's UUIDgroupId
- 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
- Specified by:
fetchFileEntry
in interfaceDLFileEntryLocalService
-
fetchFileEntry
- Specified by:
fetchFileEntry
in interfaceDLFileEntryLocalService
-
fetchFileEntryByAnyImageId
- Specified by:
fetchFileEntryByAnyImageId
in interfaceDLFileEntryLocalService
-
fetchFileEntryByExternalReferenceCode
public DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) - Specified by:
fetchFileEntryByExternalReferenceCode
in interfaceDLFileEntryLocalService
-
fetchFileEntryByFileName
- Specified by:
fetchFileEntryByFileName
in interfaceDLFileEntryLocalService
-
fetchFileEntryByName
- Specified by:
fetchFileEntryByName
in interfaceDLFileEntryLocalService
-
forEachFileEntry
public void forEachFileEntry(long companyId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Specified by:
forEachFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
forEachFileEntry
public void forEachFileEntry(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Specified by:
forEachFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQuery
in interfaceDLFileEntryLocalService
-
getDDMStructureFileEntries
- Specified by:
getDDMStructureFileEntries
in interfaceDLFileEntryLocalService
-
getDDMStructureFileEntries
- Specified by:
getDDMStructureFileEntries
in interfaceDLFileEntryLocalService
-
getDLFileEntries
Returns a range of all the document library file entries.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.- Specified by:
getDLFileEntries
in interfaceDLFileEntryLocalService
- Parameters:
start
- the lower bound of the range of document library file entriesend
- the upper bound of the range of document library file entries (not inclusive)- Returns:
- the range of document library file entries
-
getDLFileEntriesByUuidAndCompanyId
Returns all the document library file entries matching the UUID and company.- Specified by:
getDLFileEntriesByUuidAndCompanyId
in interfaceDLFileEntryLocalService
- Parameters:
uuid
- the UUID of the document library file entriescompanyId
- 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 interfaceDLFileEntryLocalService
- Parameters:
uuid
- the UUID of the document library file entriescompanyId
- the primary key of the companystart
- the lower bound of the range of document library file entriesend
- the upper bound of the range of document library file entries (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 interfaceDLFileEntryLocalService
- Returns:
- the number of document library file entries
-
getDLFileEntry
Returns the document library file entry with the primary key.- Specified by:
getDLFileEntry
in interfaceDLFileEntryLocalService
- 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 foundPortalException
-
getDLFileEntryByExternalReferenceCode
public DLFileEntry getDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
getDLFileEntryByExternalReferenceCode
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getDLFileEntryByUuidAndGroupId
Returns the document library file entry matching the UUID and group.- Specified by:
getDLFileEntryByUuidAndGroupId
in interfaceDLFileEntryLocalService
- Parameters:
uuid
- the document library file entry's UUIDgroupId
- 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 foundPortalException
-
getExportActionableDynamicQuery
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQuery
in interfaceDLFileEntryLocalService
-
getExtraSettingsFileEntries
- Specified by:
getExtraSettingsFileEntries
in interfaceDLFileEntryLocalService
-
getExtraSettingsFileEntriesCount
public int getExtraSettingsFileEntriesCount()- Specified by:
getExtraSettingsFileEntriesCount
in interfaceDLFileEntryLocalService
-
getFileAsStream
- Specified by:
getFileAsStream
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileAsStream
public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException - Specified by:
getFileAsStream
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileAsStream
public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment) throws PortalException - Specified by:
getFileAsStream
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntries
- Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntries
- Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntries
- Specified by:
getFileEntries
in interfaceDLFileEntryLocalService
-
getFileEntriesByClassNameIdAndTreePath
- Specified by:
getFileEntriesByClassNameIdAndTreePath
in interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount()- Specified by:
getFileEntriesCount
in interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long folderId) - Specified by:
getFileEntriesCount
in interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long folderId, int status) - Specified by:
getFileEntriesCount
in interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntriesCount
in interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntriesCount
in interfaceDLFileEntryLocalService
-
getFileEntry
- Specified by:
getFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntry
- Specified by:
getFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntryByExternalReferenceCode
public DLFileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
getFileEntryByExternalReferenceCode
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntryByFileName
public DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException - Specified by:
getFileEntryByFileName
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntryByName
public DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws PortalException - Specified by:
getFileEntryByName
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntryByUuidAndGroupId
- Specified by:
getFileEntryByUuidAndGroupId
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getFileEntryTypeIds
- Specified by:
getFileEntryTypeIds
in interfaceDLFileEntryLocalService
-
getGroupFileEntries
- Specified by:
getGroupFileEntries
in interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntries
in interfaceDLFileEntryLocalService
-
getGroupFileEntries
- Specified by:
getGroupFileEntries
in interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntries
in interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntries
in interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntries
in interfaceDLFileEntryLocalService
-
getGroupFileEntriesCount
public int getGroupFileEntriesCount(long groupId) - Specified by:
getGroupFileEntriesCount
in interfaceDLFileEntryLocalService
-
getGroupFileEntriesCount
public int getGroupFileEntriesCount(long groupId, long userId) - Specified by:
getGroupFileEntriesCount
in interfaceDLFileEntryLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQuery
in interfaceDLFileEntryLocalService
-
getNoAssetFileEntries
- Specified by:
getNoAssetFileEntries
in interfaceDLFileEntryLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceDLFileEntryLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModel
in interfaceDLFileEntryLocalService
- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
PortalException
-
getRepositoryFileEntries
- Specified by:
getRepositoryFileEntries
in interfaceDLFileEntryLocalService
-
getRepositoryFileEntriesCount
public int getRepositoryFileEntriesCount(long repositoryId) - Specified by:
getRepositoryFileEntriesCount
in interfaceDLFileEntryLocalService
-
getUniqueTitle
public String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) throws PortalException - Specified by:
getUniqueTitle
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
hasExtraSettings
public boolean hasExtraSettings()- Specified by:
hasExtraSettings
in interfaceDLFileEntryLocalService
-
hasFileEntryLock
- Specified by:
hasFileEntryLock
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
hasFileEntryLock
public boolean hasFileEntryLock(long userId, long fileEntryId, long folderId) - Specified by:
hasFileEntryLock
in interfaceDLFileEntryLocalService
-
incrementViewCounter
- Specified by:
incrementViewCounter
in interfaceDLFileEntryLocalService
-
isFileEntryCheckedOut
public boolean isFileEntryCheckedOut(long fileEntryId) - Specified by:
isFileEntryCheckedOut
in interfaceDLFileEntryLocalService
-
lockFileEntry
- Specified by:
lockFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
moveFileEntry
public DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException - Specified by:
moveFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
rebuildTree
- Specified by:
rebuildTree
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
revertFileEntry
public void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext) throws PortalException - Specified by:
revertFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
search
public Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws PortalException - Specified by:
search
in interfaceDLFileEntryLocalService
- 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 interfaceDLFileEntryLocalService
- Throws:
PortalException
-
setTreePaths
- Specified by:
setTreePaths
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
unlockFileEntry
public void unlockFileEntry(long fileEntryId) - Specified by:
unlockFileEntry
in interfaceDLFileEntryLocalService
-
updateDLFileEntry
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 interfaceDLFileEntryLocalService
- 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 displayDate, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException- Specified by:
updateFileEntry
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
updateFileEntryType
public DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Specified by:
updateFileEntryType
in interfaceDLFileEntryLocalService
- 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 interfaceDLFileEntryLocalService
- Throws:
PortalException
-
updateStatus
public DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Specified by:
updateStatus
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
validateFile
public void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) throws PortalException - Specified by:
validateFile
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
verifyFileEntryCheckOut
- Specified by:
verifyFileEntryCheckOut
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
verifyFileEntryLock
- Specified by:
verifyFileEntryLock
in interfaceDLFileEntryLocalService
- Throws:
PortalException
-
getBasePersistence
- Specified by:
getBasePersistence
in interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<DLFileEntry>
- Specified by:
getCTPersistence
in interfaceDLFileEntryLocalService
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<DLFileEntry>
- Specified by:
getModelClass
in interfaceDLFileEntryLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntry>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<DLFileEntry>
- Specified by:
updateWithUnsafeFunction
in interfaceDLFileEntryLocalService
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<DLFileEntryLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<DLFileEntryLocalService>
-