public class DLFileEntryLocalServiceWrapper extends Object implements DLFileEntryLocalService, ServiceWrapper<DLFileEntryLocalService>
DLFileEntryLocalService
.DLFileEntryLocalService
Constructor and Description |
---|
DLFileEntryLocalServiceWrapper() |
DLFileEntryLocalServiceWrapper(DLFileEntryLocalService dlFileEntryLocalService) |
Modifier and Type | Method and Description |
---|---|
DLFileEntry |
addDLFileEntry(DLFileEntry dlFileEntry)
Adds the document library file entry to the database.
|
DLFileEntry |
addFileEntry(long userId,
long groupId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
long fileEntryTypeId,
Map<String,DDMFormValues> ddmFormValuesMap,
File file,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
addFileEntry(String, long, long, long, long, String, String,
String, String, String, long, Map, File, InputStream, long,
Date, Date, ServiceContext) |
DLFileEntry |
addFileEntry(String externalReferenceCode,
long userId,
long groupId,
long repositoryId,
long folderId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
long fileEntryTypeId,
Map<String,DDMFormValues> ddmFormValuesMap,
File file,
InputStream inputStream,
long size,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext) |
DLFileVersion |
cancelCheckOut(long userId,
long fileEntryId) |
void |
checkFileEntries(long checkInterval) |
void |
checkInFileEntry(long userId,
long fileEntryId,
DLVersionNumberIncrease dlVersionNumberIncrease,
String changeLog,
ServiceContext serviceContext) |
void |
checkInFileEntry(long userId,
long fileEntryId,
String lockUuid,
ServiceContext serviceContext) |
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
long fileEntryTypeId,
ServiceContext serviceContext) |
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
long fileEntryTypeId,
String owner,
long expirationTime,
ServiceContext serviceContext) |
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
ServiceContext serviceContext) |
DLFileEntry |
checkOutFileEntry(long userId,
long fileEntryId,
String owner,
long expirationTime,
ServiceContext serviceContext) |
void |
convertExtraSettings(String[] keys) |
DLFileEntry |
copyFileEntry(long userId,
long groupId,
long repositoryId,
long fileEntryId,
long destFolderId,
ServiceContext serviceContext) |
void |
copyFileEntryMetadata(long companyId,
long fileEntryTypeId,
long fileEntryId,
long fromFileVersionId,
long toFileVersionId,
ServiceContext serviceContext) |
DLFileEntry |
createDLFileEntry(long fileEntryId)
Creates a new document library file entry with the primary key.
|
PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
DLFileEntry |
deleteDLFileEntry(DLFileEntry dlFileEntry)
Deletes the document library file entry from the database.
|
DLFileEntry |
deleteDLFileEntry(long fileEntryId)
Deletes the document library file entry with the primary key from the database.
|
void |
deleteFileEntries(long groupId,
long folderId) |
void |
deleteFileEntries(long groupId,
long folderId,
boolean includeTrashedEntries) |
DLFileEntry |
deleteFileEntry(DLFileEntry dlFileEntry) |
DLFileEntry |
deleteFileEntry(long fileEntryId) |
DLFileEntry |
deleteFileEntry(long userId,
long fileEntryId) |
DLFileEntry |
deleteFileVersion(long userId,
long fileEntryId,
String version) |
PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
void |
deleteRepositoryFileEntries(long repositoryId) |
void |
deleteRepositoryFileEntries(long repositoryId,
long folderId) |
void |
deleteRepositoryFileEntries(long repositoryId,
long folderId,
boolean includeTrashedEntries) |
<T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
DynamicQuery |
dynamicQuery() |
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
<T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
DLFileEntry |
fetchDLFileEntry(long fileEntryId) |
DLFileEntry |
fetchDLFileEntryByExternalReferenceCode(long groupId,
String externalReferenceCode)
Returns the document library file entry with the matching external reference code and group.
|
DLFileEntry |
fetchDLFileEntryByReferenceCode(long groupId,
String externalReferenceCode)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
fetchDLFileEntryByExternalReferenceCode(long, String) |
DLFileEntry |
fetchDLFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the document library file entry matching the UUID and group.
|
DLFileEntry |
fetchFileEntry(long groupId,
long folderId,
String title) |
DLFileEntry |
fetchFileEntry(String uuid,
long groupId) |
DLFileEntry |
fetchFileEntryByAnyImageId(long imageId) |
DLFileEntry |
fetchFileEntryByExternalReferenceCode(long groupId,
String externalReferenceCode) |
DLFileEntry |
fetchFileEntryByFileName(long groupId,
long folderId,
String fileName) |
DLFileEntry |
fetchFileEntryByName(long groupId,
long folderId,
String name) |
ActionableDynamicQuery |
getActionableDynamicQuery() |
CTPersistence<DLFileEntry> |
getCTPersistence() |
List<DLFileEntry> |
getDDMStructureFileEntries(long[] ddmStructureIds) |
List<DLFileEntry> |
getDDMStructureFileEntries(long groupId,
long[] ddmStructureIds) |
List<DLFileEntry> |
getDLFileEntries(int start,
int end)
Returns a range of all the document library file entries.
|
List<DLFileEntry> |
getDLFileEntriesByUuidAndCompanyId(String uuid,
long companyId)
Returns all the document library file entries matching the UUID and company.
|
List<DLFileEntry> |
getDLFileEntriesByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator)
Returns a range of document library file entries matching the UUID and company.
|
int |
getDLFileEntriesCount()
Returns the number of document library file entries.
|
DLFileEntry |
getDLFileEntry(long fileEntryId)
Returns the document library file entry with the primary key.
|
DLFileEntry |
getDLFileEntryByExternalReferenceCode(long groupId,
String externalReferenceCode)
Returns the document library file entry with the matching external reference code and group.
|
DLFileEntry |
getDLFileEntryByUuidAndGroupId(String uuid,
long groupId)
Returns the document library file entry matching the UUID and group.
|
ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
List<DLFileEntry> |
getExtraSettingsFileEntries(int start,
int end) |
int |
getExtraSettingsFileEntriesCount() |
InputStream |
getFileAsStream(long fileEntryId,
String version) |
InputStream |
getFileAsStream(long fileEntryId,
String version,
boolean incrementCounter) |
InputStream |
getFileAsStream(long fileEntryId,
String version,
boolean incrementCounter,
int increment) |
List<DLFileEntry> |
getFileEntries(int start,
int end) |
List<DLFileEntry> |
getFileEntries(long groupId,
long folderId) |
List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
int status,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator) |
List<DLFileEntry> |
getFileEntries(long groupId,
long folderId,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator) |
List<DLFileEntry> |
getFileEntries(long groupId,
long userId,
List<Long> repositoryIds,
List<Long> folderIds,
String[] mimeTypes,
QueryDefinition<DLFileEntry> queryDefinition) |
List<DLFileEntry> |
getFileEntries(long groupId,
long userId,
List<Long> folderIds,
String[] mimeTypes,
QueryDefinition<DLFileEntry> queryDefinition) |
List<DLFileEntry> |
getFileEntries(long folderId,
String name) |
int |
getFileEntriesCount() |
int |
getFileEntriesCount(long groupId,
long folderId) |
int |
getFileEntriesCount(long groupId,
long folderId,
int status) |
int |
getFileEntriesCount(long groupId,
long userId,
List<Long> repositoryIds,
List<Long> folderIds,
String[] mimeTypes,
QueryDefinition<DLFileEntry> queryDefinition) |
int |
getFileEntriesCount(long groupId,
long userId,
List<Long> folderIds,
String[] mimeTypes,
QueryDefinition<DLFileEntry> queryDefinition) |
DLFileEntry |
getFileEntry(long fileEntryId) |
DLFileEntry |
getFileEntry(long groupId,
long folderId,
String title) |
DLFileEntry |
getFileEntryByExternalReferenceCode(long groupId,
String externalReferenceCode) |
DLFileEntry |
getFileEntryByFileName(long groupId,
long folderId,
String fileName) |
DLFileEntry |
getFileEntryByName(long groupId,
long folderId,
String name) |
DLFileEntry |
getFileEntryByUuidAndGroupId(String uuid,
long groupId) |
List<DLFileEntry> |
getGroupFileEntries(long groupId,
int start,
int end) |
List<DLFileEntry> |
getGroupFileEntries(long groupId,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator) |
List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end) |
List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator) |
List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
long rootFolderId,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator) |
List<DLFileEntry> |
getGroupFileEntries(long groupId,
long userId,
long repositoryId,
long rootFolderId,
int start,
int end,
OrderByComparator<DLFileEntry> orderByComparator) |
int |
getGroupFileEntriesCount(long groupId) |
int |
getGroupFileEntriesCount(long groupId,
long userId) |
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
Class<DLFileEntry> |
getModelClass() |
List<DLFileEntry> |
getNoAssetFileEntries() |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
List<DLFileEntry> |
getRepositoryFileEntries(long repositoryId,
int start,
int end) |
int |
getRepositoryFileEntriesCount(long repositoryId) |
String |
getUniqueTitle(long groupId,
long folderId,
long fileEntryId,
String title,
String extension) |
DLFileEntryLocalService |
getWrappedService() |
boolean |
hasExtraSettings() |
boolean |
hasFileEntryLock(long userId,
long fileEntryId) |
boolean |
hasFileEntryLock(long userId,
long fileEntryId,
long folderId) |
void |
incrementViewCounter(DLFileEntry dlFileEntry,
int increment) |
boolean |
isFileEntryCheckedOut(long fileEntryId) |
Lock |
lockFileEntry(long userId,
long fileEntryId) |
DLFileEntry |
moveFileEntry(long userId,
long fileEntryId,
long newFolderId,
ServiceContext serviceContext) |
void |
rebuildTree(long companyId) |
void |
revertFileEntry(long userId,
long fileEntryId,
String version,
ServiceContext serviceContext) |
Hits |
search(long groupId,
long userId,
long creatorUserId,
int status,
int start,
int end) |
Hits |
search(long groupId,
long userId,
long creatorUserId,
long folderId,
String[] mimeTypes,
int status,
int start,
int end) |
void |
setTreePaths(long folderId,
String treePath,
boolean reindex) |
void |
setWrappedService(DLFileEntryLocalService dlFileEntryLocalService) |
void |
unlockFileEntry(long fileEntryId) |
DLFileEntry |
updateDLFileEntry(DLFileEntry dlFileEntry)
Updates the document library file entry in the database or adds it if it does not yet exist.
|
DLFileEntry |
updateFileEntry(long userId,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
long fileEntryTypeId,
Map<String,DDMFormValues> ddmFormValuesMap,
File file,
InputStream inputStream,
long size,
Date expirationDate,
Date reviewDate,
ServiceContext serviceContext) |
DLFileEntry |
updateFileEntry(long userId,
long fileEntryId,
String sourceFileName,
String mimeType,
String title,
String description,
String changeLog,
DLVersionNumberIncrease dlVersionNumberIncrease,
long fileEntryTypeId,
Map<String,DDMFormValues> ddmFormValuesMap,
File file,
InputStream inputStream,
long size,
ServiceContext serviceContext)
Deprecated.
|
DLFileEntry |
updateFileEntryType(long userId,
long fileEntryId,
long fileEntryTypeId,
ServiceContext serviceContext) |
void |
updateSmallImage(long smallImageId,
long largeImageId)
Deprecated.
As of Cavanaugh (7.4.x), with no direct replacement
|
DLFileEntry |
updateStatus(long userId,
DLFileEntry dlFileEntry,
DLFileVersion dlFileVersion,
int status,
ServiceContext serviceContext,
Map<String,Serializable> workflowContext) |
DLFileEntry |
updateStatus(long userId,
long fileVersionId,
int status,
ServiceContext serviceContext,
Map<String,Serializable> workflowContext) |
<R,E extends Throwable> |
updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntry>,R,E> updateUnsafeFunction) |
void |
validateFile(long groupId,
long folderId,
long fileEntryId,
String fileName,
String title) |
boolean |
verifyFileEntryCheckOut(long fileEntryId,
String lockUuid) |
boolean |
verifyFileEntryLock(long fileEntryId,
String lockUuid) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getBasePersistence
public DLFileEntryLocalServiceWrapper()
public DLFileEntryLocalServiceWrapper(DLFileEntryLocalService dlFileEntryLocalService)
public DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)
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.
addDLFileEntry
in interface DLFileEntryLocalService
dlFileEntry
- the document library file entry@Deprecated public DLFileEntry addFileEntry(long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, ServiceContext serviceContext) throws PortalException
addFileEntry(String, long, long, long, long, String, String,
String, String, String, long, Map, File, InputStream, long,
Date, Date, ServiceContext)
addFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry addFileEntry(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
addFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileVersion cancelCheckOut(long userId, long fileEntryId) throws PortalException
cancelCheckOut
in interface DLFileEntryLocalService
PortalException
public void checkFileEntries(long checkInterval) throws PortalException
checkFileEntries
in interface DLFileEntryLocalService
PortalException
public void checkInFileEntry(long userId, long fileEntryId, DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, ServiceContext serviceContext) throws PortalException
checkInFileEntry
in interface DLFileEntryLocalService
PortalException
public void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext) throws PortalException
checkInFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException
checkOutFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException
checkOutFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext) throws PortalException
checkOutFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext) throws PortalException
checkOutFileEntry
in interface DLFileEntryLocalService
PortalException
public void convertExtraSettings(String[] keys) throws PortalException
convertExtraSettings
in interface DLFileEntryLocalService
PortalException
public DLFileEntry copyFileEntry(long userId, long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext) throws PortalException
copyFileEntry
in interface DLFileEntryLocalService
PortalException
public void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long fromFileVersionId, long toFileVersionId, ServiceContext serviceContext) throws PortalException
copyFileEntryMetadata
in interface DLFileEntryLocalService
PortalException
public DLFileEntry createDLFileEntry(long fileEntryId)
createDLFileEntry
in interface DLFileEntryLocalService
fileEntryId
- the primary key for the new document library file entrypublic PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
createPersistedModel
in interface DLFileEntryLocalService
createPersistedModel
in interface PersistedModelLocalService
PortalException
public DLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry)
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.
deleteDLFileEntry
in interface DLFileEntryLocalService
dlFileEntry
- the document library file entrypublic DLFileEntry deleteDLFileEntry(long fileEntryId) throws PortalException
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.
deleteDLFileEntry
in interface DLFileEntryLocalService
fileEntryId
- the primary key of the document library file entryPortalException
- if a document library file entry with the primary key could not be foundpublic void deleteFileEntries(long groupId, long folderId) throws PortalException
deleteFileEntries
in interface DLFileEntryLocalService
PortalException
public void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries) throws PortalException
deleteFileEntries
in interface DLFileEntryLocalService
PortalException
public DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry) throws PortalException
deleteFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry deleteFileEntry(long fileEntryId) throws PortalException
deleteFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry deleteFileEntry(long userId, long fileEntryId) throws PortalException
deleteFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version) throws PortalException
deleteFileVersion
in interface DLFileEntryLocalService
PortalException
public PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface DLFileEntryLocalService
deletePersistedModel
in interface PersistedModelLocalService
PortalException
public void deleteRepositoryFileEntries(long repositoryId) throws PortalException
deleteRepositoryFileEntries
in interface DLFileEntryLocalService
PortalException
public void deleteRepositoryFileEntries(long repositoryId, long folderId) throws PortalException
deleteRepositoryFileEntries
in interface DLFileEntryLocalService
PortalException
public void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) throws PortalException
deleteRepositoryFileEntries
in interface DLFileEntryLocalService
PortalException
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface DLFileEntryLocalService
dslQuery
in interface PersistedModelLocalService
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface DLFileEntryLocalService
dslQueryCount
in interface PersistedModelLocalService
public DynamicQuery dynamicQuery()
dynamicQuery
in interface DLFileEntryLocalService
public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
in interface DLFileEntryLocalService
dynamicQuery
- the dynamic querypublic <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.
dynamicQuery
in interface DLFileEntryLocalService
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.
dynamicQuery
in interface DLFileEntryLocalService
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 (optionally null
)public long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQueryCount
in interface DLFileEntryLocalService
dynamicQuery
- the dynamic querypublic long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQueryCount
in interface DLFileEntryLocalService
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic DLFileEntry fetchDLFileEntry(long fileEntryId)
fetchDLFileEntry
in interface DLFileEntryLocalService
public DLFileEntry fetchDLFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
fetchDLFileEntryByExternalReferenceCode
in interface DLFileEntryLocalService
groupId
- the primary key of the groupexternalReferenceCode
- the document library file entry's external reference codenull
if a matching document library file entry could not be found@Deprecated public DLFileEntry fetchDLFileEntryByReferenceCode(long groupId, String externalReferenceCode)
fetchDLFileEntryByExternalReferenceCode(long, String)
fetchDLFileEntryByReferenceCode
in interface DLFileEntryLocalService
public DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid, long groupId)
fetchDLFileEntryByUuidAndGroupId
in interface DLFileEntryLocalService
uuid
- the document library file entry's UUIDgroupId
- the primary key of the groupnull
if a matching document library file entry could not be foundpublic DLFileEntry fetchFileEntry(long groupId, long folderId, String title)
fetchFileEntry
in interface DLFileEntryLocalService
public DLFileEntry fetchFileEntry(String uuid, long groupId)
fetchFileEntry
in interface DLFileEntryLocalService
public DLFileEntry fetchFileEntryByAnyImageId(long imageId)
fetchFileEntryByAnyImageId
in interface DLFileEntryLocalService
public DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
fetchFileEntryByExternalReferenceCode
in interface DLFileEntryLocalService
public DLFileEntry fetchFileEntryByFileName(long groupId, long folderId, String fileName)
fetchFileEntryByFileName
in interface DLFileEntryLocalService
public DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name)
fetchFileEntryByName
in interface DLFileEntryLocalService
public ActionableDynamicQuery getActionableDynamicQuery()
getActionableDynamicQuery
in interface DLFileEntryLocalService
public List<DLFileEntry> getDDMStructureFileEntries(long groupId, long[] ddmStructureIds)
getDDMStructureFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)
getDDMStructureFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getDLFileEntries(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl
.
getDLFileEntries
in interface DLFileEntryLocalService
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)public List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId)
getDLFileEntriesByUuidAndCompanyId
in interface DLFileEntryLocalService
uuid
- the UUID of the document library file entriescompanyId
- the primary key of the companypublic List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getDLFileEntriesByUuidAndCompanyId
in interface DLFileEntryLocalService
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 (optionally null
)public int getDLFileEntriesCount()
getDLFileEntriesCount
in interface DLFileEntryLocalService
public DLFileEntry getDLFileEntry(long fileEntryId) throws PortalException
getDLFileEntry
in interface DLFileEntryLocalService
fileEntryId
- the primary key of the document library file entryPortalException
- if a document library file entry with the primary key could not be foundpublic DLFileEntry getDLFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException
getDLFileEntryByExternalReferenceCode
in interface DLFileEntryLocalService
groupId
- the primary key of the groupexternalReferenceCode
- the document library file entry's external reference codePortalException
- if a matching document library file entry could not be foundpublic DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException
getDLFileEntryByUuidAndGroupId
in interface DLFileEntryLocalService
uuid
- the document library file entry's UUIDgroupId
- the primary key of the groupPortalException
- if a matching document library file entry could not be foundpublic ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
getExportActionableDynamicQuery
in interface DLFileEntryLocalService
public List<DLFileEntry> getExtraSettingsFileEntries(int start, int end)
getExtraSettingsFileEntries
in interface DLFileEntryLocalService
public int getExtraSettingsFileEntriesCount()
getExtraSettingsFileEntriesCount
in interface DLFileEntryLocalService
public InputStream getFileAsStream(long fileEntryId, String version) throws PortalException
getFileAsStream
in interface DLFileEntryLocalService
PortalException
public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws PortalException
getFileAsStream
in interface DLFileEntryLocalService
PortalException
public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment) throws PortalException
getFileAsStream
in interface DLFileEntryLocalService
PortalException
public List<DLFileEntry> getFileEntries(int start, int end)
getFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getFileEntries(long groupId, long folderId)
getFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
getFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
getFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getFileEntries(long folderId, String name)
getFileEntries
in interface DLFileEntryLocalService
public int getFileEntriesCount()
getFileEntriesCount
in interface DLFileEntryLocalService
public int getFileEntriesCount(long groupId, long folderId)
getFileEntriesCount
in interface DLFileEntryLocalService
public int getFileEntriesCount(long groupId, long folderId, int status)
getFileEntriesCount
in interface DLFileEntryLocalService
public int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
getFileEntriesCount
in interface DLFileEntryLocalService
public int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
getFileEntriesCount
in interface DLFileEntryLocalService
public DLFileEntry getFileEntry(long fileEntryId) throws PortalException
getFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry getFileEntry(long groupId, long folderId, String title) throws PortalException
getFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry getFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException
getFileEntryByExternalReferenceCode
in interface DLFileEntryLocalService
PortalException
public DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws PortalException
getFileEntryByFileName
in interface DLFileEntryLocalService
PortalException
public DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws PortalException
getFileEntryByName
in interface DLFileEntryLocalService
PortalException
public DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws PortalException
getFileEntryByUuidAndGroupId
in interface DLFileEntryLocalService
PortalException
public List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end)
getGroupFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getGroupFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end)
getGroupFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getGroupFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getGroupFileEntries
in interface DLFileEntryLocalService
public List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> orderByComparator)
getGroupFileEntries
in interface DLFileEntryLocalService
public int getGroupFileEntriesCount(long groupId)
getGroupFileEntriesCount
in interface DLFileEntryLocalService
public int getGroupFileEntriesCount(long groupId, long userId)
getGroupFileEntriesCount
in interface DLFileEntryLocalService
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
getIndexableActionableDynamicQuery
in interface DLFileEntryLocalService
public List<DLFileEntry> getNoAssetFileEntries()
getNoAssetFileEntries
in interface DLFileEntryLocalService
public String getOSGiServiceIdentifier()
getOSGiServiceIdentifier
in interface DLFileEntryLocalService
public PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface DLFileEntryLocalService
getPersistedModel
in interface PersistedModelLocalService
PortalException
public List<DLFileEntry> getRepositoryFileEntries(long repositoryId, int start, int end)
getRepositoryFileEntries
in interface DLFileEntryLocalService
public int getRepositoryFileEntriesCount(long repositoryId)
getRepositoryFileEntriesCount
in interface DLFileEntryLocalService
public String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) throws PortalException
getUniqueTitle
in interface DLFileEntryLocalService
PortalException
public boolean hasExtraSettings()
hasExtraSettings
in interface DLFileEntryLocalService
public boolean hasFileEntryLock(long userId, long fileEntryId) throws PortalException
hasFileEntryLock
in interface DLFileEntryLocalService
PortalException
public boolean hasFileEntryLock(long userId, long fileEntryId, long folderId)
hasFileEntryLock
in interface DLFileEntryLocalService
public void incrementViewCounter(DLFileEntry dlFileEntry, int increment)
incrementViewCounter
in interface DLFileEntryLocalService
public boolean isFileEntryCheckedOut(long fileEntryId)
isFileEntryCheckedOut
in interface DLFileEntryLocalService
public Lock lockFileEntry(long userId, long fileEntryId) throws PortalException
lockFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext) throws PortalException
moveFileEntry
in interface DLFileEntryLocalService
PortalException
public void rebuildTree(long companyId) throws PortalException
rebuildTree
in interface DLFileEntryLocalService
PortalException
public void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext) throws PortalException
revertFileEntry
in interface DLFileEntryLocalService
PortalException
public Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws PortalException
search
in interface DLFileEntryLocalService
PortalException
public Hits search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws PortalException
search
in interface DLFileEntryLocalService
PortalException
public void setTreePaths(long folderId, String treePath, boolean reindex) throws PortalException
setTreePaths
in interface DLFileEntryLocalService
PortalException
public void unlockFileEntry(long fileEntryId)
unlockFileEntry
in interface DLFileEntryLocalService
public DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
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.
updateDLFileEntry
in interface DLFileEntryLocalService
dlFileEntry
- the document library file entrypublic DLFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date expirationDate, Date reviewDate, ServiceContext serviceContext) throws PortalException
updateFileEntry
in interface DLFileEntryLocalService
PortalException
@Deprecated public DLFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, ServiceContext serviceContext) throws PortalException
updateFileEntry(long, long, String, String, String, String, String, DLVersionNumberIncrease, long, Map, File, InputStream, long, Date, Date, ServiceContext)
updateFileEntry
in interface DLFileEntryLocalService
PortalException
public DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext) throws PortalException
updateFileEntryType
in interface DLFileEntryLocalService
PortalException
@Deprecated public void updateSmallImage(long smallImageId, long largeImageId) throws PortalException
updateSmallImage
in interface DLFileEntryLocalService
PortalException
public DLFileEntry updateStatus(long userId, DLFileEntry dlFileEntry, DLFileVersion dlFileVersion, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext) throws PortalException
updateStatus
in interface DLFileEntryLocalService
PortalException
public DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext) throws PortalException
updateStatus
in interface DLFileEntryLocalService
PortalException
public void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) throws PortalException
validateFile
in interface DLFileEntryLocalService
PortalException
public boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid) throws PortalException
verifyFileEntryCheckOut
in interface DLFileEntryLocalService
PortalException
public boolean verifyFileEntryLock(long fileEntryId, String lockUuid) throws PortalException
verifyFileEntryLock
in interface DLFileEntryLocalService
PortalException
public CTPersistence<DLFileEntry> getCTPersistence()
getCTPersistence
in interface DLFileEntryLocalService
getCTPersistence
in interface CTService<DLFileEntry>
public Class<DLFileEntry> getModelClass()
getModelClass
in interface DLFileEntryLocalService
getModelClass
in interface CTService<DLFileEntry>
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileEntry>,R,E> updateUnsafeFunction) throws E extends Throwable
updateWithUnsafeFunction
in interface DLFileEntryLocalService
updateWithUnsafeFunction
in interface CTService<DLFileEntry>
E extends Throwable
public DLFileEntryLocalService getWrappedService()
getWrappedService
in interface ServiceWrapper<DLFileEntryLocalService>
public void setWrappedService(DLFileEntryLocalService dlFileEntryLocalService)
setWrappedService
in interface ServiceWrapper<DLFileEntryLocalService>