Interface DLFileEntryLocalService
- All Superinterfaces:
BaseLocalService
,CTService<DLFileEntry>
,PersistedModelLocalService
- All Known Implementing Classes:
DLFileEntryLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
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
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 interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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.
- Parameters:
dlFileEntry
- the document library file entry- Returns:
- the document library file entry that was added
-
addFileEntry
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- Throws:
PortalException
-
cancelCheckOut
- Throws:
PortalException
-
checkFileEntries
- Throws:
PortalException
-
checkInFileEntry
void checkInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkInFileEntry
void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
checkOutFileEntry
DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
convertExtraSettings
- Throws:
PortalException
-
copyFileEntry
DLFileEntry copyFileEntry(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
copyFileEntryMetadata
void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, ServiceContext serviceContext) throws PortalException - 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.- Parameters:
fileEntryId
- the primary key for the new document library file entry- Returns:
- the new document library file entry
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
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.
- 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.
- 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
- Throws:
PortalException
-
deleteFileEntries
void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries) throws PortalException - Throws:
PortalException
-
deleteFileEntry
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry) throws PortalException - Throws:
PortalException
-
deleteFileEntry
- Throws:
PortalException
-
deleteFileEntry
@Indexable(type=DELETE) DLFileEntry deleteFileEntry(long userId, long fileEntryId) throws PortalException - Throws:
PortalException
-
deleteFileEntryByExternalReferenceCode
@Indexable(type=DELETE) DLFileEntry deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
deleteFileVersion
@Indexable(type=REINDEX) DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version) throws PortalException - Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteRepositoryFileEntries
- Throws:
PortalException
-
deleteRepositoryFileEntries
- Throws:
PortalException
-
deleteRepositoryFileEntries
void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) throws PortalException - Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
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
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchDLFileEntry
-
fetchDLFileEntryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchDLFileEntryByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid, long groupId) Returns the document library file entry matching the UUID and group.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntry(long groupId, long folderId, String title) -
fetchFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntry(String uuid, long groupId) -
fetchFileEntryByAnyImageId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByAnyImageId(long imageId) -
fetchFileEntryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) -
fetchFileEntryByFileName
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByFileName(long groupId, long folderId, String fileName) -
fetchFileEntryByName
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name) -
forEachFileEntry
void forEachFileEntry(long companyId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
forEachFileEntry
void forEachFileEntry(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Throws:
PortalException
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getDDMStructureFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getDDMStructureFileEntries(long groupId, long[] ddmStructureIds) -
getDDMStructureFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds) -
getDLFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) 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
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
.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId) Returns all the document library file entries matching the UUID and company.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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.- 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
Returns the number of document library file entries.- Returns:
- the number of document library file entries
-
getDLFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getDLFileEntry(long fileEntryId) throws PortalException Returns the document library file entry with the primary key.- 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
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getDLFileEntryByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the document library file entry matching the UUID and group.- 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 found
-
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getExtraSettingsFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getExtraSettingsFileEntries(int start, int end) -
getExtraSettingsFileEntriesCount
-
getFileAsStream
@Transactional(propagation=SUPPORTS, readOnly=true) InputStream getFileAsStream(long fileEntryId, String version) throws PortalException - Throws:
PortalException
-
getFileAsStream
@Transactional(propagation=SUPPORTS, readOnly=true) InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException - Throws:
PortalException
-
getFileAsStream
@Transactional(propagation=SUPPORTS, readOnly=true) InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment) throws PortalException - Throws:
PortalException
-
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(int start, int end) -
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId) -
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntries(long folderId, String name) -
getFileEntriesByClassNameIdAndTreePath
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getFileEntriesByClassNameIdAndTreePath(long classNameId, String treePath) -
getFileEntriesCount
-
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long folderId, int status) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) -
getFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntry(long fileEntryId) throws PortalException - Throws:
PortalException
-
getFileEntry
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException - Throws:
PortalException
-
getFileEntryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntryByFileName
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException - Throws:
PortalException
-
getFileEntryByName
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws PortalException - Throws:
PortalException
-
getFileEntryByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException - Throws:
PortalException
-
getFileEntryTypeIds
@Transactional(propagation=SUPPORTS, readOnly=true) Map<Long,Long> getFileEntryTypeIds(long companyId, long[] groupIds, String treePath) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) -
getGroupFileEntriesCount
-
getGroupFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupFileEntriesCount(long groupId, long userId) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getNoAssetFileEntries
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getRepositoryFileEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileEntry> getRepositoryFileEntries(long repositoryId, int start, int end) -
getRepositoryFileEntriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getRepositoryFileEntriesCount(long repositoryId) -
getUniqueTitle
@Transactional(propagation=SUPPORTS, readOnly=true) String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) throws PortalException - Throws:
PortalException
-
hasExtraSettings
-
hasFileEntryLock
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasFileEntryLock(long userId, long fileEntryId) throws PortalException - Throws:
PortalException
-
hasFileEntryLock
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasFileEntryLock(long userId, long fileEntryId, long folderId) -
incrementViewCounter
-
isFileEntryCheckedOut
-
lockFileEntry
- Throws:
PortalException
-
moveFileEntry
@Indexable(type=REINDEX) DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
rebuildTree
- Throws:
PortalException
-
revertFileEntry
void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException - Throws:
PortalException
-
setTreePaths
- Throws:
PortalException
-
unlockFileEntry
void unlockFileEntry(long fileEntryId) -
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.
- Parameters:
dlFileEntry
- the document library file entry- Returns:
- the document library file entry that was updated
-
updateFileEntry
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- Throws:
PortalException
-
updateFileEntryType
DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateStatus
DLFileEntry updateStatus(long userId, DLFileEntry dlFileEntry, DLFileVersion dlFileVersion, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
updateStatus
DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
validateFile
void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) throws PortalException - Throws:
PortalException
-
verifyFileEntryCheckOut
- Throws:
PortalException
-
verifyFileEntryLock
- Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<DLFileEntry>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<DLFileEntry>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntry>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<DLFileEntry>
- Throws:
E extends Throwable
-