Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Interface DLFileEntryLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
DLFileEntryLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileEntryLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for DLFileEntry. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
DLFileEntryLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLFileEntryLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl

Method Summary
 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 is, long size, ServiceContext serviceContext)
           
 DLFileVersion cancelCheckOut(long userId, long fileEntryId)
           
 void checkInFileEntry(long userId, long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext)
           
 void checkInFileEntry(long userId, long fileEntryId, String lockUuid)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, long, String, ServiceContext)
 void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext)
           
 DLFileEntry checkOutFileEntry(long userId, long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, long, ServiceContext)
 DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext)
           
 DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, long, String, long, 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.
 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, long folderId)
           
 void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries)
           
 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 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 fetchFileEntryByAnyImageId(long imageId)
           
 DLFileEntry fetchFileEntryByFileName(long groupId, long folderId, String fileName)
           
 DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name)
           
 ActionableDynamicQuery getActionableDynamicQuery()
           
 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 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()
           
 File getFile(long userId, long fileEntryId, String version, boolean incrementCounter)
          Deprecated. As of 7.0.0, replaced by getFile(long, String, boolean)
 File getFile(long userId, long fileEntryId, String version, boolean incrementCounter, int increment)
          Deprecated. As of 7.0.0, replaced by getFile(long, String, boolean, int)
 File getFile(long fileEntryId, String version, boolean incrementCounter)
           
 File getFile(long fileEntryId, String version, boolean incrementCounter, int increment)
           
 InputStream getFileAsStream(long userId, long fileEntryId, String version)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String)
 InputStream getFileAsStream(long userId, long fileEntryId, String version, boolean incrementCounter)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String, boolean)
 InputStream getFileAsStream(long userId, long fileEntryId, String version, boolean incrementCounter, int increment)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String, boolean, int)
 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> obc)
           
 List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 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, DateRange dateRange, long repositoryId, QueryDefinition<DLFileEntry> queryDefinition)
          Deprecated. As of 7.0.0, with no direct replacement
 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 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> obc)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end)
           
 List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 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, int start, int end, OrderByComparator<DLFileEntry> obc)
           
 int getGroupFileEntriesCount(long groupId)
           
 int getGroupFileEntriesCount(long groupId, long userId)
           
 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
 List<DLFileEntry> getMisversionedFileEntries()
           
 List<DLFileEntry> getNoAssetFileEntries()
           
 List<DLFileEntry> getOrphanedFileEntries()
           
 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)
           
 boolean hasExtraSettings()
           
 boolean hasFileEntryLock(long userId, long fileEntryId)
           
 void incrementViewCounter(DLFileEntry dlFileEntry, int increment)
           
 boolean isFileEntryCheckedOut(long fileEntryId)
           
 boolean isKeepFileVersionLabel(long fileEntryId, ServiceContext serviceContext)
           
 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 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, boolean majorVersion, long fileEntryTypeId, Map<String,DDMFormValues> ddmFormValuesMap, File file, InputStream is, long size, ServiceContext serviceContext)
           
 DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext)
           
 void updateSmallImage(long smallImageId, long largeImageId)
           
 DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
           
 void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title)
           
 boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
           
 boolean verifyFileEntryLock(long fileEntryId, String lockUuid)
           
 

Method Detail

addDLFileEntry

@Indexable(type=REINDEX)
DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)
Adds the document library file entry to the database. Also notifies the appropriate model listeners.

Parameters:
dlFileEntry - the document library file entry
Returns:
the document library file entry that was added

addFileEntry

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

cancelCheckOut

DLFileVersion cancelCheckOut(long userId,
                             long fileEntryId)
                             throws PortalException
Throws:
PortalException

checkInFileEntry

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

Throws:
PortalException

checkInFileEntry

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

checkInFileEntry

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

checkOutFileEntry

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

Throws:
PortalException

checkOutFileEntry

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

Throws:
PortalException

checkOutFileEntry

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

checkOutFileEntry

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

convertExtraSettings

void convertExtraSettings(String[] keys)
                          throws PortalException
Throws:
PortalException

copyFileEntry

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

copyFileEntryMetadata

void copyFileEntryMetadata(long companyId,
                           long fileEntryTypeId,
                           long fileEntryId,
                           long fromFileVersionId,
                           long toFileVersionId,
                           ServiceContext serviceContext)
                           throws PortalException
Throws:
PortalException

createDLFileEntry

DLFileEntry createDLFileEntry(long fileEntryId)
Creates a new document library file entry with the primary key. Does not add the document library file entry to the database.

Parameters:
fileEntryId - the primary key for the new document library file entry
Returns:
the new document library file entry

deleteDLFileEntry

@Indexable(type=DELETE)
DLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry)
Deletes the document library file entry from the database. Also notifies the appropriate model listeners.

Parameters:
dlFileEntry - the document library file entry
Returns:
the document library file entry that was removed

deleteDLFileEntry

@Indexable(type=DELETE)
DLFileEntry deleteDLFileEntry(long fileEntryId)
                              throws PortalException
Deletes the document library file entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
fileEntryId - the primary key of the document library file entry
Returns:
the document library file entry that was removed
Throws:
PortalException - if a document library file entry with the primary key could not be found

deleteFileEntries

void deleteFileEntries(long groupId,
                       long folderId)
                       throws PortalException
Throws:
PortalException

deleteFileEntries

void deleteFileEntries(long groupId,
                       long folderId,
                       boolean includeTrashedEntries)
                       throws PortalException
Throws:
PortalException

deleteFileEntry

@Indexable(type=DELETE)
@SystemEvent(action=1,
             type=1)
DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry)
                            throws PortalException
Throws:
PortalException

deleteFileEntry

@Indexable(type=DELETE)
DLFileEntry deleteFileEntry(long fileEntryId)
                            throws PortalException
Throws:
PortalException

deleteFileEntry

@Indexable(type=DELETE)
DLFileEntry deleteFileEntry(long userId,
                                                long fileEntryId)
                            throws PortalException
Throws:
PortalException

deleteFileVersion

@Indexable(type=REINDEX)
DLFileEntry deleteFileVersion(long userId,
                                                   long fileEntryId,
                                                   String version)
                              throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

deleteRepositoryFileEntries

void deleteRepositoryFileEntries(long repositoryId,
                                 long folderId)
                                 throws PortalException
Throws:
PortalException

deleteRepositoryFileEntries

void deleteRepositoryFileEntries(long repositoryId,
                                 long folderId,
                                 boolean includeTrashedEntries)
                                 throws PortalException
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchDLFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchDLFileEntry(long fileEntryId)

fetchDLFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid,
                                                                                      long groupId)
Returns the document library file entry matching the UUID and group.

Parameters:
uuid - the document library file entry's UUID
groupId - the primary key of the group
Returns:
the matching document library file entry, or null if a matching document library file entry could not be found

fetchFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntry(long groupId,
                                                                    long folderId,
                                                                    String title)

fetchFileEntryByAnyImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntryByAnyImageId(long imageId)

fetchFileEntryByFileName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntryByFileName(long groupId,
                                                                              long folderId,
                                                                              String fileName)

fetchFileEntryByName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntryByName(long groupId,
                                                                          long folderId,
                                                                          String name)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDDMStructureFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)

getDDMStructureFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDDMStructureFileEntries(long groupId,
                                                                                      long[] ddmStructureIds)

getDLFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDLFileEntries(int start,
                                                                            int end)
Returns a range of all the document library file entries.

Useful when paginating results. Returns a maximum of end - start instances. start 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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of document library file entries
end - the upper bound of the range of document library file entries (not inclusive)
Returns:
the range of document library file entries

getDLFileEntriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid,
                                                                                              long companyId)
Returns all the document library file entries matching the UUID and company.

Parameters:
uuid - the UUID of the document library file entries
companyId - the primary key of the company
Returns:
the matching document library file entries, or an empty list if no matches were found

getDLFileEntriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid,
                                                                                              long companyId,
                                                                                              int start,
                                                                                              int end,
                                                                                              OrderByComparator<DLFileEntry> orderByComparator)
Returns a range of document library file entries matching the UUID and company.

Parameters:
uuid - the UUID of the document library file entries
companyId - the primary key of the company
start - the lower bound of the range of document library file entries
end - the upper bound of the range of document library file entries (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching document library file entries, or an empty list if no matches were found

getDLFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDLFileEntriesCount()
Returns the number of document library file entries.

Returns:
the number of document library file entries

getDLFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntry(long fileEntryId)
                           throws PortalException
Returns the document library file entry with the primary key.

Parameters:
fileEntryId - the primary key of the document library file entry
Returns:
the document library file entry
Throws:
PortalException - if a document library file entry with the primary key could not be found

getDLFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid,
                                                                                    long groupId)
                                           throws PortalException
Returns the document library file entry matching the UUID and group.

Parameters:
uuid - the document library file entry's UUID
groupId - the primary key of the group
Returns:
the matching document library file entry
Throws:
PortalException - if a matching document library file entry could not be found

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getExtraSettingsFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getExtraSettingsFileEntries(int start,
                                                                                       int end)

getExtraSettingsFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getExtraSettingsFileEntriesCount()

getFile

@Transactional(propagation=SUPPORTS,
               readOnly=true)
File getFile(long fileEntryId,
                                                      String version,
                                                      boolean incrementCounter)
             throws PortalException
Throws:
PortalException

getFile

@Transactional(propagation=SUPPORTS,
               readOnly=true)
File getFile(long fileEntryId,
                                                      String version,
                                                      boolean incrementCounter,
                                                      int increment)
             throws PortalException
Throws:
PortalException

getFile

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
File getFile(long userId,
                                                                 long fileEntryId,
                                                                 String version,
                                                                 boolean incrementCounter)
             throws PortalException
Deprecated. As of 7.0.0, replaced by getFile(long, String, boolean)

Throws:
PortalException

getFile

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
File getFile(long userId,
                                                                 long fileEntryId,
                                                                 String version,
                                                                 boolean incrementCounter,
                                                                 int increment)
             throws PortalException
Deprecated. As of 7.0.0, replaced by getFile(long, String, boolean, int)

Throws:
PortalException

getFileAsStream

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

getFileAsStream

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

getFileAsStream

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

getFileAsStream

@Deprecated
InputStream getFileAsStream(long userId,
                                       long fileEntryId,
                                       String version)
                            throws PortalException
Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String)

Throws:
PortalException

getFileAsStream

@Deprecated
InputStream getFileAsStream(long userId,
                                       long fileEntryId,
                                       String version,
                                       boolean incrementCounter)
                            throws PortalException
Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String, boolean)

Throws:
PortalException

getFileAsStream

@Deprecated
InputStream getFileAsStream(long userId,
                                       long fileEntryId,
                                       String version,
                                       boolean incrementCounter,
                                       int increment)
                            throws PortalException
Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String, boolean, int)

Throws:
PortalException

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long folderId,
                                                                          String name)

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId)

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator<DLFileEntry> obc)

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long folderId,
                                                                          int status,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator<DLFileEntry> obc)

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long userId,
                                                                          List<Long> folderIds,
                                                                          String[] mimeTypes,
                                                                          QueryDefinition<DLFileEntry> queryDefinition)
                                 throws Exception
Throws:
Exception

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(long groupId,
                                                                          long userId,
                                                                          List<Long> repositoryIds,
                                                                          List<Long> folderIds,
                                                                          String[] mimeTypes,
                                                                          QueryDefinition<DLFileEntry> queryDefinition)
                                 throws Exception
Throws:
Exception

getFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getFileEntries(int start,
                                                                          int end)

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount()

getFileEntriesCount

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                            DateRange dateRange,
                                                                            long repositoryId,
                                                                            QueryDefinition<DLFileEntry> queryDefinition)
Deprecated. As of 7.0.0, with no direct replacement


getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId)

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId,
                                                                 int status)

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long userId,
                                                                 List<Long> folderIds,
                                                                 String[] mimeTypes,
                                                                 QueryDefinition<DLFileEntry> queryDefinition)
                        throws Exception
Throws:
Exception

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long userId,
                                                                 List<Long> repositoryIds,
                                                                 List<Long> folderIds,
                                                                 String[] mimeTypes,
                                                                 QueryDefinition<DLFileEntry> queryDefinition)
                        throws Exception
Throws:
Exception

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long fileEntryId)
                         throws PortalException
Throws:
PortalException

getFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntry(long groupId,
                                                                  long folderId,
                                                                  String title)
                         throws PortalException
Throws:
PortalException

getFileEntryByName

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByName(long groupId,
                                                                        long folderId,
                                                                        String name)
                               throws PortalException
Throws:
PortalException

getFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getFileEntryByUuidAndGroupId(String uuid,
                                                                                  long groupId)
                                         throws PortalException
Throws:
PortalException

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               int start,
                                                                               int end)

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<DLFileEntry> obc)

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               long repositoryId,
                                                                               long rootFolderId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<DLFileEntry> obc)

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               long rootFolderId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<DLFileEntry> obc)

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               int start,
                                                                               int end)

getGroupFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getGroupFileEntries(long groupId,
                                                                               long userId,
                                                                               int start,
                                                                               int end,
                                                                               OrderByComparator<DLFileEntry> obc)

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId)

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMisversionedFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getMisversionedFileEntries()

getNoAssetFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getNoAssetFileEntries()

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getOrphanedFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getOrphanedFileEntries()

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

getRepositoryFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getRepositoryFileEntries(long repositoryId,
                                                                                    int start,
                                                                                    int end)

getRepositoryFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRepositoryFileEntriesCount(long repositoryId)

getUniqueTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getUniqueTitle(long groupId,
                                                               long folderId,
                                                               long fileEntryId,
                                                               String title,
                                                               String extension)
                      throws PortalException
Throws:
PortalException

hasExtraSettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasExtraSettings()

hasFileEntryLock

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFileEntryLock(long userId,
                                                                  long fileEntryId)
                         throws PortalException
Throws:
PortalException

incrementViewCounter

@BufferedIncrement(configuration="DLFileEntry",
                   incrementClass=NumberIncrement.class)
void incrementViewCounter(DLFileEntry dlFileEntry,
                                                                                            int increment)

isFileEntryCheckedOut

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isFileEntryCheckedOut(long fileEntryId)
                              throws PortalException
Throws:
PortalException

isKeepFileVersionLabel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isKeepFileVersionLabel(long fileEntryId,
                                                                        ServiceContext serviceContext)
                               throws PortalException
Throws:
PortalException

lockFileEntry

Lock lockFileEntry(long userId,
                   long fileEntryId)
                   throws PortalException
Throws:
PortalException

moveFileEntry

@Indexable(type=REINDEX)
DLFileEntry moveFileEntry(long userId,
                                               long fileEntryId,
                                               long newFolderId,
                                               ServiceContext serviceContext)
                          throws PortalException
Throws:
PortalException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException
Throws:
PortalException

revertFileEntry

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

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long userId,
                                                     long creatorUserId,
                                                     long folderId,
                                                     String[] mimeTypes,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException
Throws:
PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long userId,
                                                     long creatorUserId,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException
Throws:
PortalException

setTreePaths

void setTreePaths(long folderId,
                  String treePath,
                  boolean reindex)
                  throws PortalException
Throws:
PortalException

unlockFileEntry

void unlockFileEntry(long fileEntryId)

updateDLFileEntry

@Indexable(type=REINDEX)
DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
Updates the document library file entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
dlFileEntry - the document library file entry
Returns:
the document library file entry that was updated

updateFileEntry

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

updateFileEntryType

DLFileEntry updateFileEntryType(long userId,
                                long fileEntryId,
                                long fileEntryTypeId,
                                ServiceContext serviceContext)
                                throws PortalException
Throws:
PortalException

updateSmallImage

void updateSmallImage(long smallImageId,
                      long largeImageId)
                      throws PortalException
Throws:
PortalException

updateStatus

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

validateFile

void validateFile(long groupId,
                  long folderId,
                  long fileEntryId,
                  String fileName,
                  String title)
                  throws PortalException
Throws:
PortalException

verifyFileEntryCheckOut

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

verifyFileEntryLock

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

Liferay 7.0-ce-b4