Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service.impl
Class DLFileEntryServiceImpl

java.lang.Object
  extended by com.liferay.portal.service.BaseServiceImpl
      extended by com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl
          extended by com.liferay.portlet.documentlibrary.service.impl.DLFileEntryServiceImpl
All Implemented Interfaces:
IdentifiableOSGiService, BaseService, DLFileEntryService

public class DLFileEntryServiceImpl
extends DLFileEntryServiceBaseImpl

Provides the remote service for accessing, adding, checking in/out, deleting, locking/unlocking, moving, reverting, updating, and verifying document library file entries. Its methods include permission checks.


Field Summary
 
Fields inherited from class com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl
assetCategoryFinder, assetCategoryLocalService, assetCategoryPersistence, assetCategoryService, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetEntryService, assetLinkLocalService, assetLinkPersistence, assetTagFinder, assetTagLocalService, assetTagPersistence, assetTagService, classNameLocalService, classNamePersistence, classNameService, counterLocalService, dlAppHelperLocalService, dlFileEntryFinder, dlFileEntryLocalService, dlFileEntryMetadataFinder, dlFileEntryMetadataLocalService, dlFileEntryMetadataPersistence, dlFileEntryPersistence, dlFileEntryService, dlFileEntryTypeFinder, dlFileEntryTypeLocalService, dlFileEntryTypePersistence, dlFileEntryTypeService, dlFileVersionLocalService, dlFileVersionPersistence, dlFileVersionService, dlFolderFinder, dlFolderLocalService, dlFolderPersistence, dlFolderService, expandoRowLocalService, expandoRowPersistence, expandoTableLocalService, expandoTablePersistence, groupFinder, groupLocalService, groupPersistence, groupService, imageLocalService, imagePersistence, imageService, ratingsStatsFinder, ratingsStatsLocalService, ratingsStatsPersistence, repositoryLocalService, repositoryPersistence, repositoryService, resourceLocalService, trashEntryLocalService, trashEntryPersistence, trashEntryService, userFinder, userLocalService, userPersistence, userService, webDAVPropsLocalService, webDAVPropsPersistence, workflowInstanceLinkLocalService, workflowInstanceLinkPersistence
 
Fields inherited from class com.liferay.portal.service.BaseServiceImpl
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS
 
Constructor Summary
DLFileEntryServiceImpl()
           
 
Method Summary
 DLFileEntry addFileEntry(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 is, long size, ServiceContext serviceContext)
           
 DLFileVersion cancelCheckOut(long fileEntryId)
           
 void checkInFileEntry(long fileEntryId, boolean major, String changeLog, ServiceContext serviceContext)
           
 void checkInFileEntry(long fileEntryId, String lockUuid)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)
 void checkInFileEntry(long fileEntryId, String lockUuid, ServiceContext serviceContext)
           
 DLFileEntry checkOutFileEntry(long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)
 DLFileEntry checkOutFileEntry(long fileEntryId, ServiceContext serviceContext)
           
 DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)
 DLFileEntry checkOutFileEntry(long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
           
 DLFileEntry copyFileEntry(long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
           
 void deleteFileEntry(long fileEntryId)
           
 void deleteFileEntry(long groupId, long folderId, String title)
           
 void deleteFileVersion(long fileEntryId, String version)
           
 DLFileEntry fetchFileEntryByImageId(long imageId)
           
 InputStream getFileAsStream(long fileEntryId, String version)
           
 InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, long fileEntryTypeId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, String[] mimeTypes, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 int getFileEntriesCount(long groupId, long folderId)
           
 int getFileEntriesCount(long groupId, long folderId, int status)
           
 int getFileEntriesCount(long groupId, long folderId, long fileEntryTypeId)
           
 int getFileEntriesCount(long groupId, long folderId, String[] mimeTypes)
           
 DLFileEntry getFileEntry(long fileEntryId)
           
 DLFileEntry getFileEntry(long groupId, long folderId, String title)
           
 DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId)
           
 Lock getFileEntryLock(long fileEntryId)
           
 int getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId)
           
 int getGroupFileEntriesCount(long groupId, long userId, long repositoryId, long rootFolderId, String[] mimeTypes, int status)
           
 int getGroupFileEntriesCount(long groupId, long userId, long rootFolderId, String[] mimeTypes, int status)
           
 boolean hasFileEntryLock(long fileEntryId)
           
 boolean isFileEntryCheckedOut(long fileEntryId)
           
 boolean isKeepFileVersionLabel(long fileEntryId, ServiceContext serviceContext)
           
 DLFileEntry moveFileEntry(long fileEntryId, long newFolderId, ServiceContext serviceContext)
           
 Lock refreshFileEntryLock(String lockUuid, long companyId, long expirationTime)
           
 void revertFileEntry(long fileEntryId, String version, ServiceContext serviceContext)
           
 Hits search(long groupId, long creatorUserId, int status, int start, int end)
           
 Hits search(long groupId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
           
 DLFileEntry updateFileEntry(long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream is, long size, ServiceContext serviceContext)
           
 DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
           
 boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
           
 boolean verifyFileEntryLock(long fileEntryId, String lockUuid)
           
 
Methods inherited from class com.liferay.portlet.documentlibrary.service.base.DLFileEntryServiceBaseImpl
afterPropertiesSet, destroy, getAssetCategoryFinder, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetCategoryService, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getAssetLinkLocalService, getAssetLinkPersistence, getAssetTagFinder, getAssetTagLocalService, getAssetTagPersistence, getAssetTagService, getClassNameLocalService, getClassNamePersistence, getClassNameService, getCounterLocalService, getDLAppHelperLocalService, getDLFileEntryFinder, getDLFileEntryLocalService, getDLFileEntryMetadataFinder, getDLFileEntryMetadataLocalService, getDLFileEntryMetadataPersistence, getDLFileEntryPersistence, getDLFileEntryService, getDLFileEntryTypeFinder, getDLFileEntryTypeLocalService, getDLFileEntryTypePersistence, getDLFileEntryTypeService, getDLFileVersionLocalService, getDLFileVersionPersistence, getDLFileVersionService, getDLFolderFinder, getDLFolderLocalService, getDLFolderPersistence, getDLFolderService, getExpandoRowLocalService, getExpandoRowPersistence, getExpandoTableLocalService, getExpandoTablePersistence, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getImageLocalService, getImagePersistence, getImageService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getRatingsStatsFinder, getRatingsStatsLocalService, getRatingsStatsPersistence, getRepositoryLocalService, getRepositoryPersistence, getRepositoryService, getResourceLocalService, getTrashEntryLocalService, getTrashEntryPersistence, getTrashEntryService, getUserFinder, getUserLocalService, getUserPersistence, getUserService, getWebDAVPropsLocalService, getWebDAVPropsPersistence, getWorkflowInstanceLinkLocalService, getWorkflowInstanceLinkPersistence, runSQL, setAssetCategoryFinder, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetCategoryService, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setAssetLinkLocalService, setAssetLinkPersistence, setAssetTagFinder, setAssetTagLocalService, setAssetTagPersistence, setAssetTagService, setClassNameLocalService, setClassNamePersistence, setClassNameService, setCounterLocalService, setDLAppHelperLocalService, setDLFileEntryFinder, setDLFileEntryLocalService, setDLFileEntryMetadataFinder, setDLFileEntryMetadataLocalService, setDLFileEntryMetadataPersistence, setDLFileEntryPersistence, setDLFileEntryService, setDLFileEntryTypeFinder, setDLFileEntryTypeLocalService, setDLFileEntryTypePersistence, setDLFileEntryTypeService, setDLFileVersionLocalService, setDLFileVersionPersistence, setDLFileVersionService, setDLFolderFinder, setDLFolderLocalService, setDLFolderPersistence, setDLFolderService, setExpandoRowLocalService, setExpandoRowPersistence, setExpandoTableLocalService, setExpandoTablePersistence, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setImageLocalService, setImagePersistence, setImageService, setRatingsStatsFinder, setRatingsStatsLocalService, setRatingsStatsPersistence, setRepositoryLocalService, setRepositoryPersistence, setRepositoryService, setResourceLocalService, setTrashEntryLocalService, setTrashEntryPersistence, setTrashEntryService, setUserFinder, setUserLocalService, setUserPersistence, setUserService, setWebDAVPropsLocalService, setWebDAVPropsPersistence, setWorkflowInstanceLinkLocalService, setWorkflowInstanceLinkPersistence
 
Methods inherited from class com.liferay.portal.service.BaseServiceImpl
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileEntryServiceImpl

public DLFileEntryServiceImpl()
Method Detail

addFileEntry

public DLFileEntry addFileEntry(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 is,
                                long size,
                                ServiceContext serviceContext)
                         throws PortalException
Throws:
PortalException

cancelCheckOut

public DLFileVersion cancelCheckOut(long fileEntryId)
                             throws PortalException
Throws:
PortalException

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             boolean major,
                             String changeLog,
                             ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

checkInFileEntry

@Deprecated
public void checkInFileEntry(long fileEntryId,
                                        String lockUuid)
                      throws PortalException
Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, String, ServiceContext)

Throws:
PortalException

checkInFileEntry

public void checkInFileEntry(long fileEntryId,
                             String lockUuid,
                             ServiceContext serviceContext)
                      throws PortalException
Throws:
PortalException

checkOutFileEntry

@Deprecated
public DLFileEntry checkOutFileEntry(long fileEntryId)
                              throws PortalException
Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, ServiceContext)

Throws:
PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long fileEntryId,
                                     ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

checkOutFileEntry

@Deprecated
public DLFileEntry checkOutFileEntry(long fileEntryId,
                                                String owner,
                                                long expirationTime)
                              throws PortalException
Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, String, long, ServiceContext)

Throws:
PortalException

checkOutFileEntry

public DLFileEntry checkOutFileEntry(long fileEntryId,
                                     String owner,
                                     long expirationTime,
                                     ServiceContext serviceContext)
                              throws PortalException
Throws:
PortalException

copyFileEntry

public DLFileEntry copyFileEntry(long groupId,
                                 long repositoryId,
                                 long fileEntryId,
                                 long destFolderId,
                                 ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

deleteFileEntry

public void deleteFileEntry(long fileEntryId)
                     throws PortalException
Throws:
PortalException

deleteFileEntry

public void deleteFileEntry(long groupId,
                            long folderId,
                            String title)
                     throws PortalException
Throws:
PortalException

deleteFileVersion

public void deleteFileVersion(long fileEntryId,
                              String version)
                       throws PortalException
Throws:
PortalException

fetchFileEntryByImageId

public DLFileEntry fetchFileEntryByImageId(long imageId)
                                    throws PortalException
Throws:
PortalException

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version)
                            throws PortalException
Throws:
PortalException

getFileAsStream

public InputStream getFileAsStream(long fileEntryId,
                                   String version,
                                   boolean incrementCounter)
                            throws PortalException
Throws:
PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        int status,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException
Throws:
PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException
Throws:
PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        long fileEntryTypeId,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException
Throws:
PortalException

getFileEntries

public List<DLFileEntry> getFileEntries(long groupId,
                                        long folderId,
                                        String[] mimeTypes,
                                        int start,
                                        int end,
                                        OrderByComparator<DLFileEntry> obc)
                                 throws PortalException
Throws:
PortalException

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 folderId,
                               long fileEntryTypeId)

getFileEntriesCount

public int getFileEntriesCount(long groupId,
                               long folderId,
                               String[] mimeTypes)

getFileEntry

public DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException
Throws:
PortalException

getFileEntry

public DLFileEntry getFileEntry(long groupId,
                                long folderId,
                                String title)
                         throws PortalException
Throws:
PortalException

getFileEntryByUuidAndGroupId

public DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                long groupId)
                                         throws PortalException
Throws:
PortalException

getFileEntryLock

public Lock getFileEntryLock(long fileEntryId)

getFoldersFileEntriesCount

public int getFoldersFileEntriesCount(long groupId,
                                      List<Long> folderIds,
                                      int status)

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long rootFolderId,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> obc)
                                      throws PortalException
Throws:
PortalException

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long repositoryId,
                                             long rootFolderId,
                                             String[] mimeTypes,
                                             int status,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> obc)
                                      throws PortalException
Throws:
PortalException

getGroupFileEntries

public List<DLFileEntry> getGroupFileEntries(long groupId,
                                             long userId,
                                             long rootFolderId,
                                             String[] mimeTypes,
                                             int status,
                                             int start,
                                             int end,
                                             OrderByComparator<DLFileEntry> obc)
                                      throws PortalException
Throws:
PortalException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long rootFolderId)
                             throws PortalException
Throws:
PortalException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long repositoryId,
                                    long rootFolderId,
                                    String[] mimeTypes,
                                    int status)
                             throws PortalException
Throws:
PortalException

getGroupFileEntriesCount

public int getGroupFileEntriesCount(long groupId,
                                    long userId,
                                    long rootFolderId,
                                    String[] mimeTypes,
                                    int status)
                             throws PortalException
Throws:
PortalException

hasFileEntryLock

public boolean hasFileEntryLock(long fileEntryId)
                         throws PortalException
Throws:
PortalException

isFileEntryCheckedOut

public boolean isFileEntryCheckedOut(long fileEntryId)
                              throws PortalException
Throws:
PortalException

isKeepFileVersionLabel

public boolean isKeepFileVersionLabel(long fileEntryId,
                                      ServiceContext serviceContext)
                               throws PortalException
Throws:
PortalException

moveFileEntry

public DLFileEntry moveFileEntry(long fileEntryId,
                                 long newFolderId,
                                 ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

refreshFileEntryLock

public Lock refreshFileEntryLock(String lockUuid,
                                 long companyId,
                                 long expirationTime)
                          throws PortalException
Throws:
PortalException

revertFileEntry

public void revertFileEntry(long fileEntryId,
                            String version,
                            ServiceContext serviceContext)
                     throws PortalException
Throws:
PortalException

search

public Hits search(long groupId,
                   long creatorUserId,
                   int status,
                   int start,
                   int end)
            throws PortalException
Throws:
PortalException

search

public Hits search(long groupId,
                   long creatorUserId,
                   long folderId,
                   String[] mimeTypes,
                   int status,
                   int start,
                   int end)
            throws PortalException
Throws:
PortalException

updateFileEntry

public DLFileEntry updateFileEntry(long fileEntryId,
                                   String sourceFileName,
                                   String mimeType,
                                   String title,
                                   String description,
                                   String changeLog,
                                   boolean majorVersion,
                                   long fileEntryTypeId,
                                   Map<String,DDMFormValues> ddmFormValuesMap,
                                   File file,
                                   InputStream is,
                                   long size,
                                   ServiceContext serviceContext)
                            throws PortalException
Throws:
PortalException

updateStatus

public DLFileEntry updateStatus(long userId,
                                long fileVersionId,
                                int status,
                                ServiceContext serviceContext,
                                Map<String,Serializable> workflowContext)
                         throws PortalException
Throws:
PortalException

verifyFileEntryCheckOut

public boolean verifyFileEntryCheckOut(long fileEntryId,
                                       String lockUuid)
                                throws PortalException
Throws:
PortalException

verifyFileEntryLock

public boolean verifyFileEntryLock(long fileEntryId,
                                   String lockUuid)
                            throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4