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) voidcheckFileEntries(long companyId, long checkInterval) voidcheckInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) voidcheckInFileEntry(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) voidconvertExtraSettings(String[] keys) copyFileEntry(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, ServiceContext serviceContext) voidcopyFileEntryMetadata(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.voiddeleteFileEntries(long groupId, long folderId) voiddeleteFileEntries(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) voiddeleteRepositoryFileEntries(long repositoryId) voiddeleteRepositoryFileEntries(long repositoryId, long folderId) voiddeleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(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.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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) voidforEachFileEntry(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) voidforEachFileEntry(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.intReturns 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) intgetFileAsStream(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) intintgetFileEntriesCount(long groupId, long folderId) intgetFileEntriesCount(long groupId, long folderId, int status) intgetFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) intgetFileEntriesCount(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) intgetGroupFileEntriesCount(long groupId) intgetGroupFileEntriesCount(long groupId, long userId) Returns the OSGi service identifier.getPersistedModel(Serializable primaryKeyObj) getRepositoryFileEntries(long repositoryId, int start, int end) intgetRepositoryFileEntriesCount(long repositoryId) getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) booleanbooleanhasFileEntryLock(long userId, long fileEntryId) booleanhasFileEntryLock(long userId, long fileEntryId, long folderId) voidincrementViewCounter(DLFileEntry dlFileEntry, int increment) booleanisFileEntryCheckedOut(long fileEntryId) lockFileEntry(long userId, long fileEntryId) moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) voidrebuildTree(long companyId) voidrevertFileEntry(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) voidsetTreePaths(long folderId, String treePath, boolean reindex) voidsetWrappedService(DLFileEntryLocalService dlFileEntryLocalService) voidunlockFileEntry(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) voidvalidateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) booleanverifyFileEntryCheckOut(long fileEntryId, String lockUuid) booleanverifyFileEntryLock(long fileEntryId, String lockUuid) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
addDLFileEntryin 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:
addFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
cancelCheckOut
- Specified by:
cancelCheckOutin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkFileEntries
- Specified by:
checkFileEntriesin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkInFileEntry
public void checkInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException - Specified by:
checkInFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkInFileEntry
public void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException - Specified by:
checkInFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
checkOutFileEntry
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException - Specified by:
checkOutFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
convertExtraSettings
- Specified by:
convertExtraSettingsin 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:
copyFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
copyFileEntryMetadata
public void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, ServiceContext serviceContext) throws PortalException - Specified by:
copyFileEntryMetadatain 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:
createDLFileEntryin interfaceDLFileEntryLocalService- Parameters:
fileEntryId- the primary key for the new document library file entry- Returns:
- the new document library file entry
-
createPersistedModel
- Specified by:
createPersistedModelin interfaceDLFileEntryLocalService- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Throws:
PortalExceptionPortalException
-
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:
deleteDLFileEntryin 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:
deleteDLFileEntryin 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:
deleteFileEntriesin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteFileEntries
public void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries) throws PortalException - Specified by:
deleteFileEntriesin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteFileEntry
- Specified by:
deleteFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteFileEntry
- Specified by:
deleteFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteFileEntry
- Specified by:
deleteFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteFileEntryByExternalReferenceCode
public DLFileEntry deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
deleteFileEntryByExternalReferenceCodein interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteFileVersion
public DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version) throws PortalException - Specified by:
deleteFileVersionin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfaceDLFileEntryLocalService- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Throws:
PortalExceptionPortalException
-
deleteRepositoryFileEntries
- Specified by:
deleteRepositoryFileEntriesin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteRepositoryFileEntries
- Specified by:
deleteRepositoryFileEntriesin interfaceDLFileEntryLocalService- Throws:
PortalException
-
deleteRepositoryFileEntries
public void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) throws PortalException - Specified by:
deleteRepositoryFileEntriesin interfaceDLFileEntryLocalService- Throws:
PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfaceDLFileEntryLocalService- Specified by:
dslQueryin interfacePersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfaceDLFileEntryLocalService- Specified by:
dslQueryCountin interfacePersistedModelLocalService
-
dynamicQuery
- Specified by:
dynamicQueryin interfaceDLFileEntryLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl.- Specified by:
dynamicQueryin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl.- Specified by:
dynamicQueryin 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:
dynamicQueryCountin 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:
dynamicQueryCountin 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:
fetchDLFileEntryin interfaceDLFileEntryLocalService
-
fetchDLFileEntryByExternalReferenceCode
public DLFileEntry fetchDLFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) - Specified by:
fetchDLFileEntryByExternalReferenceCodein interfaceDLFileEntryLocalService
-
fetchDLFileEntryByUuidAndGroupId
Returns the document library file entry matching the UUID and group.- Specified by:
fetchDLFileEntryByUuidAndGroupIdin interfaceDLFileEntryLocalService- Parameters:
uuid- the document library file entry's UUIDgroupId- the primary key of the group- Returns:
- the matching document library file entry, or
nullif a matching document library file entry could not be found
-
fetchFileEntry
- Specified by:
fetchFileEntryin interfaceDLFileEntryLocalService
-
fetchFileEntry
- Specified by:
fetchFileEntryin interfaceDLFileEntryLocalService
-
fetchFileEntryByAnyImageId
- Specified by:
fetchFileEntryByAnyImageIdin interfaceDLFileEntryLocalService
-
fetchFileEntryByExternalReferenceCode
public DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) - Specified by:
fetchFileEntryByExternalReferenceCodein interfaceDLFileEntryLocalService
-
fetchFileEntryByFileName
- Specified by:
fetchFileEntryByFileNamein interfaceDLFileEntryLocalService
-
fetchFileEntryByName
- Specified by:
fetchFileEntryByNamein interfaceDLFileEntryLocalService
-
forEachFileEntry
public void forEachFileEntry(long companyId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Specified by:
forEachFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
forEachFileEntry
public void forEachFileEntry(long companyId, long classNameId, Consumer<DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws PortalException - Specified by:
forEachFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQueryin interfaceDLFileEntryLocalService
-
getDDMStructureFileEntries
- Specified by:
getDDMStructureFileEntriesin interfaceDLFileEntryLocalService
-
getDDMStructureFileEntries
- Specified by:
getDDMStructureFileEntriesin interfaceDLFileEntryLocalService
-
getDLFileEntries
Returns a range of all the document library file entries.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl.- Specified by:
getDLFileEntriesin 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:
getDLFileEntriesByUuidAndCompanyIdin 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:
getDLFileEntriesByUuidAndCompanyIdin 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:
getDLFileEntriesCountin interfaceDLFileEntryLocalService- Returns:
- the number of document library file entries
-
getDLFileEntry
Returns the document library file entry with the primary key.- Specified by:
getDLFileEntryin 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:
getDLFileEntryByExternalReferenceCodein interfaceDLFileEntryLocalService- Throws:
PortalException
-
getDLFileEntryByUuidAndGroupId
Returns the document library file entry matching the UUID and group.- Specified by:
getDLFileEntryByUuidAndGroupIdin 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:
getExportActionableDynamicQueryin interfaceDLFileEntryLocalService
-
getExtraSettingsFileEntries
- Specified by:
getExtraSettingsFileEntriesin interfaceDLFileEntryLocalService
-
getExtraSettingsFileEntriesCount
public int getExtraSettingsFileEntriesCount()- Specified by:
getExtraSettingsFileEntriesCountin interfaceDLFileEntryLocalService
-
getFileAsStream
- Specified by:
getFileAsStreamin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileAsStream
public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException - Specified by:
getFileAsStreamin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileAsStream
public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment) throws PortalException - Specified by:
getFileAsStreamin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntries
- Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntries
- Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntries
public List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntries
- Specified by:
getFileEntriesin interfaceDLFileEntryLocalService
-
getFileEntriesByClassNameIdAndTreePath
- Specified by:
getFileEntriesByClassNameIdAndTreePathin interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount()- Specified by:
getFileEntriesCountin interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long folderId) - Specified by:
getFileEntriesCountin interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long folderId, int status) - Specified by:
getFileEntriesCountin interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntriesCountin interfaceDLFileEntryLocalService
-
getFileEntriesCount
public int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition) - Specified by:
getFileEntriesCountin interfaceDLFileEntryLocalService
-
getFileEntry
- Specified by:
getFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntry
- Specified by:
getFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntryByExternalReferenceCode
public DLFileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Specified by:
getFileEntryByExternalReferenceCodein interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntryByFileName
public DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException - Specified by:
getFileEntryByFileNamein interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntryByName
public DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws PortalException - Specified by:
getFileEntryByNamein interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntryByUuidAndGroupId
- Specified by:
getFileEntryByUuidAndGroupIdin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getFileEntryTypeIds
- Specified by:
getFileEntryTypeIdsin interfaceDLFileEntryLocalService
-
getGroupFileEntries
- Specified by:
getGroupFileEntriesin interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntriesin interfaceDLFileEntryLocalService
-
getGroupFileEntries
- Specified by:
getGroupFileEntriesin interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntriesin interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntriesin interfaceDLFileEntryLocalService
-
getGroupFileEntries
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator) - Specified by:
getGroupFileEntriesin interfaceDLFileEntryLocalService
-
getGroupFileEntriesCount
public int getGroupFileEntriesCount(long groupId) - Specified by:
getGroupFileEntriesCountin interfaceDLFileEntryLocalService
-
getGroupFileEntriesCount
public int getGroupFileEntriesCount(long groupId, long userId) - Specified by:
getGroupFileEntriesCountin interfaceDLFileEntryLocalService
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQueryin interfaceDLFileEntryLocalService
-
getNoAssetFileEntries
- Specified by:
getNoAssetFileEntriesin interfaceDLFileEntryLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceDLFileEntryLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModelin interfaceDLFileEntryLocalService- Specified by:
getPersistedModelin interfacePersistedModelLocalService- Throws:
PortalExceptionPortalException
-
getRepositoryFileEntries
- Specified by:
getRepositoryFileEntriesin interfaceDLFileEntryLocalService
-
getRepositoryFileEntriesCount
public int getRepositoryFileEntriesCount(long repositoryId) - Specified by:
getRepositoryFileEntriesCountin interfaceDLFileEntryLocalService
-
getUniqueTitle
public String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) throws PortalException - Specified by:
getUniqueTitlein interfaceDLFileEntryLocalService- Throws:
PortalException
-
hasExtraSettings
public boolean hasExtraSettings()- Specified by:
hasExtraSettingsin interfaceDLFileEntryLocalService
-
hasFileEntryLock
- Specified by:
hasFileEntryLockin interfaceDLFileEntryLocalService- Throws:
PortalException
-
hasFileEntryLock
public boolean hasFileEntryLock(long userId, long fileEntryId, long folderId) - Specified by:
hasFileEntryLockin interfaceDLFileEntryLocalService
-
incrementViewCounter
- Specified by:
incrementViewCounterin interfaceDLFileEntryLocalService
-
isFileEntryCheckedOut
public boolean isFileEntryCheckedOut(long fileEntryId) - Specified by:
isFileEntryCheckedOutin interfaceDLFileEntryLocalService
-
lockFileEntry
- Specified by:
lockFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
moveFileEntry
public DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException - Specified by:
moveFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
rebuildTree
- Specified by:
rebuildTreein interfaceDLFileEntryLocalService- Throws:
PortalException
-
revertFileEntry
public void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext) throws PortalException - Specified by:
revertFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
search
public Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws PortalException - Specified by:
searchin 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:
searchin interfaceDLFileEntryLocalService- Throws:
PortalException
-
setTreePaths
- Specified by:
setTreePathsin interfaceDLFileEntryLocalService- Throws:
PortalException
-
unlockFileEntry
public void unlockFileEntry(long fileEntryId) - Specified by:
unlockFileEntryin 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:
updateDLFileEntryin 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:
updateFileEntryin interfaceDLFileEntryLocalService- Throws:
PortalException
-
updateFileEntryType
public DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException - Specified by:
updateFileEntryTypein 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:
updateStatusin interfaceDLFileEntryLocalService- Throws:
PortalException
-
updateStatus
public DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String, Serializable> workflowContext) throws PortalException- Specified by:
updateStatusin interfaceDLFileEntryLocalService- Throws:
PortalException
-
validateFile
public void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) throws PortalException - Specified by:
validateFilein interfaceDLFileEntryLocalService- Throws:
PortalException
-
verifyFileEntryCheckOut
- Specified by:
verifyFileEntryCheckOutin interfaceDLFileEntryLocalService- Throws:
PortalException
-
verifyFileEntryLock
- Specified by:
verifyFileEntryLockin interfaceDLFileEntryLocalService- Throws:
PortalException
-
getBasePersistence
- Specified by:
getBasePersistencein interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistencein interfaceCTService<DLFileEntry>- Specified by:
getCTPersistencein interfaceDLFileEntryLocalService
-
getModelClass
- Specified by:
getModelClassin interfaceCTService<DLFileEntry>- Specified by:
getModelClassin interfaceDLFileEntryLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntry>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfaceCTService<DLFileEntry>- Specified by:
updateWithUnsafeFunctionin interfaceDLFileEntryLocalService- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedServicein interfaceServiceWrapper<DLFileEntryLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfaceServiceWrapper<DLFileEntryLocalService>
-