Liferay 7.0-ce-b4

com.liferay.portlet.documentlibrary.service
Class DLFileEntryLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.DLFileEntryLocalServiceUtil

@ProviderType
public class DLFileEntryLocalServiceUtil
extends Object

Provides the local service utility for DLFileEntry. This utility wraps DLFileEntryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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:
DLFileEntryLocalService, DLFileEntryLocalServiceBaseImpl, DLFileEntryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
DLFileEntryLocalServiceUtil()
           
 
Method Summary
static DLFileEntry addDLFileEntry(DLFileEntry dlFileEntry)
          Adds the document library file entry to the database.
static 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)
           
static DLFileVersion cancelCheckOut(long userId, long fileEntryId)
           
static void checkInFileEntry(long userId, long fileEntryId, boolean majorVersion, String changeLog, ServiceContext serviceContext)
           
static void checkInFileEntry(long userId, long fileEntryId, String lockUuid)
          Deprecated. As of 6.2.0, replaced by checkInFileEntry(long, long, String, ServiceContext)
static void checkInFileEntry(long userId, long fileEntryId, String lockUuid, ServiceContext serviceContext)
           
static DLFileEntry checkOutFileEntry(long userId, long fileEntryId)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, long, ServiceContext)
static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, ServiceContext serviceContext)
           
static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime)
          Deprecated. As of 6.2.0, replaced by checkOutFileEntry(long, long, String, long, ServiceContext)
static DLFileEntry checkOutFileEntry(long userId, long fileEntryId, String owner, long expirationTime, ServiceContext serviceContext)
           
static void convertExtraSettings(String[] keys)
           
static DLFileEntry copyFileEntry(long userId, long groupId, long repositoryId, long fileEntryId, long destFolderId, ServiceContext serviceContext)
           
static void copyFileEntryMetadata(long companyId, long fileEntryTypeId, long fileEntryId, long fromFileVersionId, long toFileVersionId, ServiceContext serviceContext)
           
static DLFileEntry createDLFileEntry(long fileEntryId)
          Creates a new document library file entry with the primary key.
static DLFileEntry deleteDLFileEntry(DLFileEntry dlFileEntry)
          Deletes the document library file entry from the database.
static DLFileEntry deleteDLFileEntry(long fileEntryId)
          Deletes the document library file entry with the primary key from the database.
static void deleteFileEntries(long groupId, long folderId)
           
static void deleteFileEntries(long groupId, long folderId, boolean includeTrashedEntries)
           
static DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry)
           
static DLFileEntry deleteFileEntry(long fileEntryId)
           
static DLFileEntry deleteFileEntry(long userId, long fileEntryId)
           
static DLFileEntry deleteFileVersion(long userId, long fileEntryId, String version)
           
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static void deleteRepositoryFileEntries(long repositoryId, long folderId)
           
static void deleteRepositoryFileEntries(long repositoryId, long folderId, boolean includeTrashedEntries)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<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.
static
<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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static DLFileEntry fetchDLFileEntry(long fileEntryId)
           
static DLFileEntry fetchDLFileEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file entry matching the UUID and group.
static DLFileEntry fetchFileEntry(long groupId, long folderId, String title)
           
static DLFileEntry fetchFileEntryByAnyImageId(long imageId)
           
static DLFileEntry fetchFileEntryByFileName(long groupId, long folderId, String fileName)
           
static DLFileEntry fetchFileEntryByName(long groupId, long folderId, String name)
           
static ActionableDynamicQuery getActionableDynamicQuery()
           
static List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)
           
static List<DLFileEntry> getDDMStructureFileEntries(long groupId, long[] ddmStructureIds)
           
static List<DLFileEntry> getDLFileEntries(int start, int end)
          Returns a range of all the document library file entries.
static List<DLFileEntry> getDLFileEntriesByUuidAndCompanyId(String uuid, long companyId)
          Returns all the document library file entries matching the UUID and company.
static 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.
static int getDLFileEntriesCount()
          Returns the number of document library file entries.
static DLFileEntry getDLFileEntry(long fileEntryId)
          Returns the document library file entry with the primary key.
static DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file entry matching the UUID and group.
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static List<DLFileEntry> getExtraSettingsFileEntries(int start, int end)
           
static int getExtraSettingsFileEntriesCount()
           
static File getFile(long userId, long fileEntryId, String version, boolean incrementCounter)
          Deprecated. As of 7.0.0, replaced by getFile(long, String, boolean)
static 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)
static File getFile(long fileEntryId, String version, boolean incrementCounter)
           
static File getFile(long fileEntryId, String version, boolean incrementCounter, int increment)
           
static InputStream getFileAsStream(long userId, long fileEntryId, String version)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String)
static InputStream getFileAsStream(long userId, long fileEntryId, String version, boolean incrementCounter)
          Deprecated. As of 7.0.0, replaced by getFileAsStream(long, String, boolean)
static 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)
static InputStream getFileAsStream(long fileEntryId, String version)
           
static InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter)
           
static InputStream getFileAsStream(long fileEntryId, String version, boolean incrementCounter, int increment)
           
static List<DLFileEntry> getFileEntries(int start, int end)
           
static List<DLFileEntry> getFileEntries(long groupId, long folderId)
           
static List<DLFileEntry> getFileEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<DLFileEntry> obc)
           
static List<DLFileEntry> getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
static List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
           
static List<DLFileEntry> getFileEntries(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
           
static List<DLFileEntry> getFileEntries(long folderId, String name)
           
static int getFileEntriesCount()
           
static int getFileEntriesCount(long groupId, DateRange dateRange, long repositoryId, QueryDefinition<DLFileEntry> queryDefinition)
          Deprecated. As of 7.0.0, with no direct replacement
static int getFileEntriesCount(long groupId, long folderId)
           
static int getFileEntriesCount(long groupId, long folderId, int status)
           
static int getFileEntriesCount(long groupId, long userId, List<Long> repositoryIds, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
           
static int getFileEntriesCount(long groupId, long userId, List<Long> folderIds, String[] mimeTypes, QueryDefinition<DLFileEntry> queryDefinition)
           
static DLFileEntry getFileEntry(long fileEntryId)
           
static DLFileEntry getFileEntry(long groupId, long folderId, String title)
           
static DLFileEntry getFileEntryByName(long groupId, long folderId, String name)
           
static DLFileEntry getFileEntryByUuidAndGroupId(String uuid, long groupId)
           
static List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end)
           
static List<DLFileEntry> getGroupFileEntries(long groupId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end)
           
static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
static List<DLFileEntry> getGroupFileEntries(long groupId, long userId, long repositoryId, long rootFolderId, int start, int end, OrderByComparator<DLFileEntry> obc)
           
static int getGroupFileEntriesCount(long groupId)
           
static int getGroupFileEntriesCount(long groupId, long userId)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static List<DLFileEntry> getMisversionedFileEntries()
           
static List<DLFileEntry> getNoAssetFileEntries()
           
static List<DLFileEntry> getOrphanedFileEntries()
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static List<DLFileEntry> getRepositoryFileEntries(long repositoryId, int start, int end)
           
static int getRepositoryFileEntriesCount(long repositoryId)
           
static DLFileEntryLocalService getService()
           
static String getUniqueTitle(long groupId, long folderId, long fileEntryId, String title, String extension)
           
static boolean hasExtraSettings()
           
static boolean hasFileEntryLock(long userId, long fileEntryId)
           
static void incrementViewCounter(DLFileEntry dlFileEntry, int increment)
           
static boolean isFileEntryCheckedOut(long fileEntryId)
           
static boolean isKeepFileVersionLabel(long fileEntryId, ServiceContext serviceContext)
           
static Lock lockFileEntry(long userId, long fileEntryId)
           
static DLFileEntry moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext)
           
static void rebuildTree(long companyId)
           
static void revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext)
           
static Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end)
           
static Hits search(long groupId, long userId, long creatorUserId, long folderId, String[] mimeTypes, int status, int start, int end)
           
static void setTreePaths(long folderId, String treePath, boolean reindex)
           
static void unlockFileEntry(long fileEntryId)
           
static DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
          Updates the document library file entry in the database or adds it if it does not yet exist.
static 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)
           
static DLFileEntry updateFileEntryType(long userId, long fileEntryId, long fileEntryTypeId, ServiceContext serviceContext)
           
static void updateSmallImage(long smallImageId, long largeImageId)
           
static DLFileEntry updateStatus(long userId, long fileVersionId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)
           
static void validateFile(long groupId, long folderId, long fileEntryId, String fileName, String title)
           
static boolean verifyFileEntryCheckOut(long fileEntryId, String lockUuid)
           
static boolean verifyFileEntryLock(long fileEntryId, String lockUuid)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileEntryLocalServiceUtil

public DLFileEntryLocalServiceUtil()
Method Detail

addDLFileEntry

public static 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

public static 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

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

checkInFileEntry

@Deprecated
public static 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

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

checkInFileEntry

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

checkOutFileEntry

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

Throws:
PortalException

checkOutFileEntry

@Deprecated
public static 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

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

checkOutFileEntry

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

convertExtraSettings

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

copyFileEntry

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

copyFileEntryMetadata

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

createDLFileEntry

public static 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

public static 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

public static 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

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

deleteFileEntries

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

deleteFileEntry

public static DLFileEntry deleteFileEntry(DLFileEntry dlFileEntry)
                                   throws PortalException
Throws:
PortalException

deleteFileEntry

public static DLFileEntry deleteFileEntry(long fileEntryId)
                                   throws PortalException
Throws:
PortalException

deleteFileEntry

public static DLFileEntry deleteFileEntry(long userId,
                                          long fileEntryId)
                                   throws PortalException
Throws:
PortalException

deleteFileVersion

public static DLFileEntry deleteFileVersion(long userId,
                                            long fileEntryId,
                                            String version)
                                     throws PortalException
Throws:
PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

deleteRepositoryFileEntries

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

deleteRepositoryFileEntries

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

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public static <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 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

public static <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 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

public static 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

public static 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

public static DLFileEntry fetchDLFileEntry(long fileEntryId)

fetchDLFileEntryByUuidAndGroupId

public static 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

public static DLFileEntry fetchFileEntry(long groupId,
                                         long folderId,
                                         String title)

fetchFileEntryByAnyImageId

public static DLFileEntry fetchFileEntryByAnyImageId(long imageId)

fetchFileEntryByFileName

public static DLFileEntry fetchFileEntryByFileName(long groupId,
                                                   long folderId,
                                                   String fileName)

fetchFileEntryByName

public static DLFileEntry fetchFileEntryByName(long groupId,
                                               long folderId,
                                               String name)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDDMStructureFileEntries

public static List<DLFileEntry> getDDMStructureFileEntries(long[] ddmStructureIds)

getDDMStructureFileEntries

public static List<DLFileEntry> getDDMStructureFileEntries(long groupId,
                                                           long[] ddmStructureIds)

getDLFileEntries

public static 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 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

public static 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

public static 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

public static int getDLFileEntriesCount()
Returns the number of document library file entries.

Returns:
the number of document library file entries

getDLFileEntry

public static 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

public static 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

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getExtraSettingsFileEntries

public static List<DLFileEntry> getExtraSettingsFileEntries(int start,
                                                            int end)

getExtraSettingsFileEntriesCount

public static int getExtraSettingsFileEntriesCount()

getFile

public static File getFile(long fileEntryId,
                           String version,
                           boolean incrementCounter)
                    throws PortalException
Throws:
PortalException

getFile

public static File getFile(long fileEntryId,
                           String version,
                           boolean incrementCounter,
                           int increment)
                    throws PortalException
Throws:
PortalException

getFile

@Deprecated
public static 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
public static 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

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

getFileAsStream

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

getFileAsStream

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

getFileAsStream

@Deprecated
public static 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
public static 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
public static 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

public static List<DLFileEntry> getFileEntries(long folderId,
                                               String name)

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId)

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> obc)

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               int status,
                                               int start,
                                               int end,
                                               OrderByComparator<DLFileEntry> obc)

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long userId,
                                               List<Long> folderIds,
                                               String[] mimeTypes,
                                               QueryDefinition<DLFileEntry> queryDefinition)
                                        throws Exception
Throws:
Exception

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long userId,
                                               List<Long> repositoryIds,
                                               List<Long> folderIds,
                                               String[] mimeTypes,
                                               QueryDefinition<DLFileEntry> queryDefinition)
                                        throws Exception
Throws:
Exception

getFileEntries

public static List<DLFileEntry> getFileEntries(int start,
                                               int end)

getFileEntriesCount

public static int getFileEntriesCount()

getFileEntriesCount

@Deprecated
public static int getFileEntriesCount(long groupId,
                                                 DateRange dateRange,
                                                 long repositoryId,
                                                 QueryDefinition<DLFileEntry> queryDefinition)
Deprecated. As of 7.0.0, with no direct replacement


getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId)

getFileEntriesCount

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

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long userId,
                                      List<Long> folderIds,
                                      String[] mimeTypes,
                                      QueryDefinition<DLFileEntry> queryDefinition)
                               throws Exception
Throws:
Exception

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long userId,
                                      List<Long> repositoryIds,
                                      List<Long> folderIds,
                                      String[] mimeTypes,
                                      QueryDefinition<DLFileEntry> queryDefinition)
                               throws Exception
Throws:
Exception

getFileEntry

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

getFileEntry

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

getFileEntryByName

public static DLFileEntry getFileEntryByName(long groupId,
                                             long folderId,
                                             String name)
                                      throws PortalException
Throws:
PortalException

getFileEntryByUuidAndGroupId

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

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    int start,
                                                    int end)

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> obc)

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long repositoryId,
                                                    long rootFolderId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> obc)

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    long rootFolderId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> obc)

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    int start,
                                                    int end)

getGroupFileEntries

public static List<DLFileEntry> getGroupFileEntries(long groupId,
                                                    long userId,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<DLFileEntry> obc)

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId)

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMisversionedFileEntries

public static List<DLFileEntry> getMisversionedFileEntries()

getNoAssetFileEntries

public static List<DLFileEntry> getNoAssetFileEntries()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getOrphanedFileEntries

public static List<DLFileEntry> getOrphanedFileEntries()

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getRepositoryFileEntries

public static List<DLFileEntry> getRepositoryFileEntries(long repositoryId,
                                                         int start,
                                                         int end)

getRepositoryFileEntriesCount

public static int getRepositoryFileEntriesCount(long repositoryId)

getUniqueTitle

public static String getUniqueTitle(long groupId,
                                    long folderId,
                                    long fileEntryId,
                                    String title,
                                    String extension)
                             throws PortalException
Throws:
PortalException

hasExtraSettings

public static boolean hasExtraSettings()

hasFileEntryLock

public static boolean hasFileEntryLock(long userId,
                                       long fileEntryId)
                                throws PortalException
Throws:
PortalException

incrementViewCounter

public static void incrementViewCounter(DLFileEntry dlFileEntry,
                                        int increment)

isFileEntryCheckedOut

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

isKeepFileVersionLabel

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

lockFileEntry

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

moveFileEntry

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

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException
Throws:
PortalException

revertFileEntry

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

search

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

search

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

setTreePaths

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

unlockFileEntry

public static void unlockFileEntry(long fileEntryId)

updateDLFileEntry

public static 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

public static 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

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

updateSmallImage

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

updateStatus

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

validateFile

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

verifyFileEntryCheckOut

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

verifyFileEntryLock

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

getService

public static DLFileEntryLocalService getService()

Liferay 7.0-ce-b4