Liferay 6.2.0

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
abstract  DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)
          Adds the document library file entry to the database.
abstract  DLFileEntry addFileEntry(long userId, long groupId, long repositoryId, long folderId, String sourceFileName, String mimeType, String title, String description, String changeLog, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
           
abstract  DLFileVersion cancelCheckOut(long userId, long fileEntryId)
           
abstract  void checkInFileEntry(long userId, long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext)
           
abstract  void checkInFileEntry(long userId, long fileEntryId, String lockUuid)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, long, String, ServiceContext)
abstract  void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext)
           
abstract  DLFileEntry checkOutFileEntry(long userId, long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, long, ServiceContext)
abstract  DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext)
           
abstract  DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, long, String, long, ServiceContext)
abstract  DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
           
abstract  void convertExtraSettings(String[] keys)
           
abstract  void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long fromFileVersionId, long toFileVersionId, ServiceContext serviceContext)
           
abstract  DLFileEntry createDLFileEntry(long fileEntryId)
          Creates a new document library file entry with the primary key.
abstract  DLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry)
          Deletes the document library file entry from the database.
abstract  DLFileEntry deleteDLFileEntry(long fileEntryId)
          Deletes the document library file entry with the primary key from the database.
abstract  void deleteFileEntries(long groupId, long folderId)
           
abstract  void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries)
           
abstract  DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry)
           
abstract  DLFileEntry deleteFileEntry(long fileEntryId)
           
abstract  DLFileEntry deleteFileEntry(long userId, long fileEntryId)
           
abstract  DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version)
           
abstract  void deleteRepositoryFileEntries(long repositoryId, long folderId)
           
abstract  void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries)
           
abstract  DynamicQuery dynamicQuery()
           
abstract  List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
abstract  List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
abstract  long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
abstract  DLFileEntry fetchDLFileEntry(long fileEntryId)
           
abstract  DLFileEntry fetchDLFileEntryByUuidAndCompanyId(String uuid, long companyId)
          Returns the document library file entry with the matching UUID and company.
abstract  DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file entry matching the UUID and group.
abstract  DLFileEntry fetchFileEntry(long groupId, long folderId, String title)
           
abstract  DLFileEntry fetchFileEntryByAnyImageId(long imageId)
           
abstract  DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name)
           
abstract  String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
abstract  List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)
           
abstract  List<DLFileEntry> getDDMStructureFileEntries(long groupId, long[] ddmStructureIds)
           
abstract  List<DLFileEntry> getDLFileEntries(int start, int end)
          Returns a range of all the document library file entries.
abstract  int getDLFileEntriesCount()
          Returns the number of document library file entries.
abstract  DLFileEntry getDLFileEntry(long fileEntryId)
          Returns the document library file entry with the primary key.
abstract  DLFileEntry getDLFileEntryByUuidAndCompanyId(String uuid, long companyId)
          Returns the document library file entry with the matching UUID and company.
abstract  DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file entry matching the UUID and group.
abstract  List<DLFileEntry> getExtraSettingsFileEntries(int start, int end)
           
abstract  int getExtraSettingsFileEntriesCount()
           
abstract  File getFile(long userId, long fileEntryId, String version, boolean incrementCounter)
           
abstract  File getFile(long userId, long fileEntryId, String version, boolean incrementCounter, int increment)
           
abstract  InputStream getFileAsStream(long userId, long fileEntryId, String version)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String)
abstract  InputStream getFileAsStream(long userId, long fileEntryId, String version, boolean incrementCounter)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String, boolean)
abstract  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)
abstract  InputStream getFileAsStream(long fileEntryId, String version)
           
abstract  InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
           
abstract  InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment)
           
abstract  List<DLFileEntry> getFileEntries(int start, int end)
           
abstract  List<DLFileEntry> getFileEntries(long groupId, long folderId)
           
abstract  List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator obc)
           
abstract  List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
           
abstract  List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition queryDefinition)
           
abstract  List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition queryDefinition)
           
abstract  List<DLFileEntry> getFileEntries(long folderId, String name)
           
abstract  int getFileEntriesCount()
           
abstract  int getFileEntriesCount(long groupId, DateRange dateRange, long repositoryId, QueryDefinition queryDefinition)
           
abstract  int getFileEntriesCount(long groupId, long folderId)
           
abstract  int getFileEntriesCount(long groupId, long folderId, int status)
           
abstract  int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition queryDefinition)
           
abstract  int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition queryDefinition)
           
abstract  DLFileEntry getFileEntry(long fileEntryId)
           
abstract  DLFileEntry getFileEntry(long groupId, long folderId, String title)
           
abstract  DLFileEntry getFileEntryByName(long groupId, long folderId, String name)
           
abstract  DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId)
           
abstract  List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end)
           
abstract  List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator obc)
           
abstract  List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end)
           
abstract  List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator obc)
           
abstract  int getGroupFileEntriesCount(long groupId)
           
abstract  int getGroupFileEntriesCount(long groupId, long userId)
           
abstract  List<DLFileEntry> getMisversionedFileEntries()
           
abstract  List<DLFileEntry> getNoAssetFileEntries()
           
abstract  List<DLFileEntry> getOrphanedFileEntries()
           
abstract  PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
abstract  String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension)
           
abstract  boolean hasExtraSettings()
           
abstract  boolean hasFileEntryLock(long userId, long fileEntryId)
           
abstract  void incrementViewCounter(DLFileEntry dlFileEntry, int increment)
           
abstract  boolean isFileEntryCheckedOut(long fileEntryId)
           
abstract  Lock lockFileEntry(long userId, long fileEntryId)
           
abstract  DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext)
           
abstract  void rebuildTree(long companyId)
           
abstract  void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext)
           
abstract  Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end)
           
abstract  Hits search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
           
abstract  void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
abstract  void setTreePaths(long folderId, String treePath, boolean reindex)
           
abstract  void unlockFileEntry(long fileEntryId)
           
abstract  DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
          Updates the document library file entry in the database or adds it if it does not yet exist.
abstract  DLFileEntry updateFileEntry(long userId, long fileEntryId, String sourceFileName, String mimeType, String title, String description, String changeLog, boolean majorVersion, long fileEntryTypeId, Map<String,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
           
abstract  void updateSmallImage(long smallImageId, long largeImageId)
           
abstract  DLFileEntry updateStatus(long userId, long fileVersionId, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext)
           
abstract  void validateFile(long groupId, long folderId, long fileEntryId, String title, String extension)
           
abstract  boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
           
abstract  boolean verifyFileEntryLock(long fileEntryId, String lockUuid)
           
 

Method Detail

addDLFileEntry

@Indexable(type=REINDEX)
DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)
                           throws SystemException
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
Throws:
SystemException - if a system exception occurred

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(long fileEntryId)
                              throws PortalException,
                                     SystemException
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
SystemException - if a system exception occurred

deleteDLFileEntry

@Indexable(type=DELETE)
DLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry)
                              throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchDLFileEntry

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

fetchDLFileEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchDLFileEntryByUuidAndCompanyId(String uuid,
                                                                                        long companyId)
                                               throws SystemException
Returns the document library file entry with the matching UUID and company.

Parameters:
uuid - the document library file entry's UUID
companyId - the primary key of the company
Returns:
the matching document library file entry, or null if a matching document library file entry could not be found
Throws:
SystemException - if a system exception occurred

fetchDLFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid,
                                                                                      long groupId)
                                             throws SystemException
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
Throws:
SystemException - if a system exception occurred

getDLFileEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntry(long fileEntryId)
                           throws PortalException,
                                  SystemException
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
SystemException - if a system exception occurred

getPersistedModel

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

getDLFileEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntryByUuidAndCompanyId(String uuid,
                                                                                      long companyId)
                                             throws PortalException,
                                                    SystemException
Returns the document library file entry with the matching UUID and company.

Parameters:
uuid - the document library file entry's UUID
companyId - the primary key of the company
Returns:
the matching document library file entry
Throws:
PortalException - if a matching document library file entry could not be found
SystemException - if a system exception occurred

getDLFileEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid,
                                                                                    long groupId)
                                           throws PortalException,
                                                  SystemException
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
SystemException - if a system exception occurred

getDLFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getDLFileEntries(int start,
                                                                            int end)
                                   throws SystemException
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
Throws:
SystemException - if a system exception occurred

getDLFileEntriesCount

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

Returns:
the number of document library file entries
Throws:
SystemException - if a system exception occurred

updateDLFileEntry

@Indexable(type=REINDEX)
DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
                              throws SystemException
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
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

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,Fields> fieldsMap,
                         File file,
                         InputStream is,
                         long size,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

cancelCheckOut

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

checkInFileEntry

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

checkInFileEntry

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

Throws:
PortalException
SystemException

checkInFileEntry

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

checkOutFileEntry

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

Throws:
PortalException
SystemException

checkOutFileEntry

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

checkOutFileEntry

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

Throws:
PortalException
SystemException

checkOutFileEntry

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

convertExtraSettings

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

copyFileEntryMetadata

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

deleteFileEntries

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

deleteFileEntries

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

deleteFileEntry

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

deleteFileEntry

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

deleteFileEntry

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

deleteFileVersion

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

deleteRepositoryFileEntries

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

deleteRepositoryFileEntries

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

fetchFileEntry

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

fetchFileEntryByAnyImageId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileEntry fetchFileEntryByAnyImageId(long imageId)
                                       throws SystemException
Throws:
SystemException

fetchFileEntryByName

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

getDDMStructureFileEntries

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

getDDMStructureFileEntries

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

getExtraSettingsFileEntries

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

getExtraSettingsFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getExtraSettingsFileEntriesCount()
                                     throws SystemException
Throws:
SystemException

getFile

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

getFile

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

getFileAsStream

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

Throws:
PortalException
SystemException

getFileAsStream

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

Throws:
PortalException
SystemException

getFileAsStream

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

Throws:
PortalException
SystemException

getFileAsStream

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

getFileAsStream

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

getFileAsStream

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

getFileEntries

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

getFileEntries

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

getFileEntries

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

getFileEntries

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

getFileEntries

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

getFileEntries

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

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount()
                        throws SystemException
Throws:
SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 DateRange dateRange,
                                                                 long repositoryId,
                                                                 QueryDefinition queryDefinition)
                        throws SystemException
Throws:
SystemException

getFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileEntriesCount(long groupId,
                                                                 long folderId)
                        throws SystemException
Throws:
SystemException

getFileEntriesCount

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

getFileEntriesCount

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

getFileEntry

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

getFileEntry

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

getFileEntryByName

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

getFileEntryByUuidAndGroupId

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

getGroupFileEntries

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

getGroupFileEntries

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

getGroupFileEntries

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

getGroupFileEntries

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

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId)
                             throws SystemException
Throws:
SystemException

getGroupFileEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupFileEntriesCount(long groupId,
                                                                      long userId)
                             throws SystemException
Throws:
SystemException

getMisversionedFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getMisversionedFileEntries()
                                             throws SystemException
Throws:
SystemException

getNoAssetFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getNoAssetFileEntries()
                                        throws SystemException
Throws:
SystemException

getOrphanedFileEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileEntry> getOrphanedFileEntries()
                                         throws SystemException
Throws:
SystemException

getUniqueTitle

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

hasExtraSettings

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasExtraSettings()
                         throws SystemException
Throws:
SystemException

hasFileEntryLock

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

incrementViewCounter

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

isFileEntryCheckedOut

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

lockFileEntry

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

moveFileEntry

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

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

revertFileEntry

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

search

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

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,
                   SystemException
Throws:
PortalException
SystemException

setTreePaths

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

unlockFileEntry

void unlockFileEntry(long fileEntryId)
                     throws SystemException
Throws:
SystemException

updateFileEntry

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

updateSmallImage

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

updateStatus

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

verifyFileEntryCheckOut

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

verifyFileEntryLock

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

validateFile

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

Liferay 6.2.0