Class DLFileEntryLocalServiceImpl

Object
com.liferay.portal.kernel.service.BaseLocalServiceImpl
com.liferay.portlet.documentlibrary.service.base.DLFileEntryLocalServiceBaseImpl
com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl
All Implemented Interfaces:
com.liferay.document.library.kernel.service.DLFileEntryLocalService, com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService, com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<com.liferay.document.library.kernel.model.DLFileEntry>, com.liferay.portal.kernel.service.PersistedModelLocalService

public class DLFileEntryLocalServiceImpl extends DLFileEntryLocalServiceBaseImpl
Provides the local service for accessing, adding, checking in/out, deleting, locking/unlocking, moving, reverting, updating, and verifying document library file entries.

Due to legacy code, the names of some file entry properties are not intuitive. Each file entry has both a name and title. The name is a unique identifier for a given file and is generally numeric, whereas the title is the actual name specified by the user (such as "Budget.xls").

Author:
Brian Wing Shun Chan, Harry Mark, Alexander Chow, Manuel de la Peña
  • Constructor Details

    • DLFileEntryLocalServiceImpl

      public DLFileEntryLocalServiceImpl()
  • Method Details

    • addFileEntry

      public com.liferay.document.library.kernel.model.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,com.liferay.dynamic.data.mapping.kernel.DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • cancelCheckOut

      public com.liferay.document.library.kernel.model.DLFileVersion cancelCheckOut(long userId, long fileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkFileEntries

      public void checkFileEntries(long companyId, long checkInterval) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkInFileEntry

      public void checkInFileEntry(long userId, long fileEntryId, com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease, String changeLog, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkInFileEntry

      public void checkInFileEntry(long userId, long fileEntryId, String lockUuid, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkOutFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkOutFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry checkOutFileEntry(long userId, long fileEntryId, long fileEntryTypeId, String owner, long expirationTime, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkOutFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry checkOutFileEntry(long userId, long fileEntryId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkOutFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • convertExtraSettings

      public void convertExtraSettings(String[] keys) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry copyFileEntry(long userId, long groupId, long repositoryId, long sourceFileEntryId, long targetFolderId, String fileName, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • copyFileEntryMetadata

      public void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long sourceFileVersionId, long targetFileVersionId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileEntries

      public void deleteFileEntries(long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileEntries

      public void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileEntry

      @Indexable(type=DELETE) @SystemEvent(action=1, type=1) public com.liferay.document.library.kernel.model.DLFileEntry deleteFileEntry(com.liferay.document.library.kernel.model.DLFileEntry dlFileEntry) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileEntry

      @Indexable(type=DELETE) public com.liferay.document.library.kernel.model.DLFileEntry deleteFileEntry(long fileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileEntry

      @Indexable(type=DELETE) public com.liferay.document.library.kernel.model.DLFileEntry deleteFileEntry(long userId, long fileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileEntryByExternalReferenceCode

      @Indexable(type=DELETE) public com.liferay.document.library.kernel.model.DLFileEntry deleteFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFileVersion

      @Indexable(type=REINDEX) public com.liferay.document.library.kernel.model.DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteRepositoryFileEntries

      public void deleteRepositoryFileEntries(long repositoryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteRepositoryFileEntries

      public void deleteRepositoryFileEntries(long repositoryId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteRepositoryFileEntries

      public void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry fetchFileEntry(long groupId, long folderId, String title)
    • fetchFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry fetchFileEntry(String uuid, long groupId)
    • fetchFileEntryByAnyImageId

      public com.liferay.document.library.kernel.model.DLFileEntry fetchFileEntryByAnyImageId(long imageId)
    • fetchFileEntryByExternalReferenceCode

      public com.liferay.document.library.kernel.model.DLFileEntry fetchFileEntryByExternalReferenceCode(long groupId, String externalReferenceCode)
    • fetchFileEntryByFileName

      public com.liferay.document.library.kernel.model.DLFileEntry fetchFileEntryByFileName(long groupId, long folderId, String fileName)
    • fetchFileEntryByName

      public com.liferay.document.library.kernel.model.DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name)
    • forEachFileEntry

      public void forEachFileEntry(long companyId, Consumer<com.liferay.document.library.kernel.model.DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • forEachFileEntry

      public void forEachFileEntry(long companyId, long classNameId, Consumer<com.liferay.document.library.kernel.model.DLFileEntry> consumer, long maximumSize, String[] mimeTypes) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getDDMStructureFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getDDMStructureFileEntries(long groupId, long[] ddmStructureIds)
    • getDDMStructureFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)
    • getExtraSettingsFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getExtraSettingsFileEntries(int start, int end)
    • getExtraSettingsFileEntriesCount

      public int getExtraSettingsFileEntriesCount()
    • getFileAsStream

      public InputStream getFileAsStream(long fileEntryId, String version) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileAsStream

      public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileAsStream

      public InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(int start, int end)
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(long groupId, long folderId)
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator)
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator)
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, com.liferay.portal.kernel.dao.orm.QueryDefinition<com.liferay.document.library.kernel.model.DLFileEntry> queryDefinition)
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, com.liferay.portal.kernel.dao.orm.QueryDefinition<com.liferay.document.library.kernel.model.DLFileEntry> queryDefinition)
    • getFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntries(long folderId, String name)
    • getFileEntriesByClassNameIdAndTreePath

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getFileEntriesByClassNameIdAndTreePath(long classNameId, String treePath)
    • getFileEntriesCount

      public int getFileEntriesCount()
    • getFileEntriesCount

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

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

      public int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, com.liferay.portal.kernel.dao.orm.QueryDefinition<com.liferay.document.library.kernel.model.DLFileEntry> queryDefinition)
    • getFileEntriesCount

      public int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, com.liferay.portal.kernel.dao.orm.QueryDefinition<com.liferay.document.library.kernel.model.DLFileEntry> queryDefinition)
    • getFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry getFileEntry(long fileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry getFileEntry(long groupId, long folderId, String title) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntryByExternalReferenceCode

      public com.liferay.document.library.kernel.model.DLFileEntry getFileEntryByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntryByFileName

      public com.liferay.document.library.kernel.model.DLFileEntry getFileEntryByFileName(long groupId, long folderId, String fileName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntryByName

      public com.liferay.document.library.kernel.model.DLFileEntry getFileEntryByName(long groupId, long folderId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntryByUuidAndGroupId

      public com.liferay.document.library.kernel.model.DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFileEntryTypeIds

      public Map<Long,Long> getFileEntryTypeIds(long companyId, long[] groupIds, String treePath)
    • getGroupFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getGroupFileEntries(long groupId, int start, int end)
    • getGroupFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getGroupFileEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator)
    • getGroupFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end)
    • getGroupFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator)
    • getGroupFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator)
    • getGroupFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.document.library.kernel.model.DLFileEntry> orderByComparator)
    • getGroupFileEntriesCount

      public int getGroupFileEntriesCount(long groupId)
    • getGroupFileEntriesCount

      public int getGroupFileEntriesCount(long groupId, long userId)
    • getNoAssetFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getNoAssetFileEntries()
    • getRepositoryFileEntries

      public List<com.liferay.document.library.kernel.model.DLFileEntry> getRepositoryFileEntries(long repositoryId, int start, int end)
    • getRepositoryFileEntriesCount

      public int getRepositoryFileEntriesCount(long repositoryId)
    • getUniqueTitle

      public String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • hasExtraSettings

      public boolean hasExtraSettings()
    • hasFileEntryLock

      public boolean hasFileEntryLock(long userId, long fileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • hasFileEntryLock

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

      @Transactional(enabled=false) public void incrementViewCounter(com.liferay.document.library.kernel.model.DLFileEntry dlFileEntry, int increment)
    • isFileEntryCheckedOut

      public boolean isFileEntryCheckedOut(long fileEntryId)
    • lockFileEntry

      public com.liferay.portal.kernel.lock.Lock lockFileEntry(long userId, long fileEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveFileEntry

      @Indexable(type=REINDEX) public com.liferay.document.library.kernel.model.DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • rebuildTree

      public void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • revertFileEntry

      public void revertFileEntry(long userId, long fileEntryId, String version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public com.liferay.portal.kernel.search.Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public com.liferay.portal.kernel.search.Hits search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setTreePaths

      public void setTreePaths(long folderId, String treePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unlockFileEntry

      public void unlockFileEntry(long fileEntryId)
    • updateFileEntry

      public com.liferay.document.library.kernel.model.DLFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String urlTitle, String description, String changeLog, com.liferay.document.library.kernel.model.DLVersionNumberIncrease dlVersionNumberIncrease, long fileEntryTypeId, Map<String,com.liferay.dynamic.data.mapping.kernel.DDMFormValues> ddmFormValuesMap, File file, InputStream inputStream, long size, Date displayDate, Date expirationDate, Date reviewDate, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFileEntryType

      public com.liferay.document.library.kernel.model.DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public com.liferay.document.library.kernel.model.DLFileEntry updateStatus(long userId, com.liferay.document.library.kernel.model.DLFileEntry dlFileEntry, com.liferay.document.library.kernel.model.DLFileVersion dlFileVersion, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String,Serializable> workflowContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public com.liferay.document.library.kernel.model.DLFileEntry updateStatus(long userId, long fileVersionId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext, Map<String,Serializable> workflowContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validateFile

      public void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • verifyFileEntryCheckOut

      public boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • verifyFileEntryLock

      public boolean verifyFileEntryLock(long fileEntryId, String lockUuid) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException