com.liferay.portlet.documentlibrary.service
Class DLFileEntryLocalServiceUtil

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

public class DLFileEntryLocalServiceUtil
extends Object

The utility for the document library file entry local service. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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, com.liferay.portlet.documentlibrary.service.base.DLFileEntryLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileEntryLocalServiceImpl

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,Fields> fieldsMap, 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)
static DLFileEntry	checkOutFileEntry(long userId, long fileEntryId) Deprecated. 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. 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 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	deleteFileEntry(long fileEntryId)
static void	deleteFileEntry(long userId, long fileEntryId)
static void	deleteFileVersion(long userId, long fileEntryId, String version)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static DLFileEntry	fetchDLFileEntry(long fileEntryId)
static DLFileEntry	fetchFileEntryByAnyImageId(long imageId)
static DLFileEntry	fetchFileEntryByName(long groupId, long folderId, String name)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<DLFileEntry>	getDLFileEntries(int start, int end) Returns a range of all the document library file entries.
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 with the UUID in the group.
static List<DLFileEntry>	getExtraSettingsFileEntries(int start, int end)
static File	getFile(long userId, long fileEntryId, String version, boolean incrementCounter)
static InputStream	getFileAsStream(long userId, long fileEntryId, String version)
static InputStream	getFileAsStream(long userId, long fileEntryId, String version, boolean incrementCounter)
static List<DLFileEntry>	getFileEntries(int start, int end)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
static List<DLFileEntry>	getFileEntries(long folderId, String name)
static int	getFileEntriesCount()
static int	getFileEntriesCount(long groupId, long folderId)
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 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 obc)
static int	getGroupFileEntriesCount(long groupId)
static int	getGroupFileEntriesCount(long groupId, long userId)
static List<DLFileEntry>	getMisversionedFileEntries()
static List<DLFileEntry>	getNoAssetFileEntries()
static List<DLFileEntry>	getOrphanedFileEntries()
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLFileEntryLocalService	getService()
static boolean	hasExtraSettings()
static boolean	hasFileEntryLock(long userId, long fileEntryId)
static boolean	isFileEntryCheckedOut(long fileEntryId)
static DLFileEntry	moveFileEntry(long userId, long fileEntryId, long newFolderId, ServiceContext serviceContext)
static void	revertFileEntry(long userId, long fileEntryId, String version, ServiceContext serviceContext)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(DLFileEntryLocalService service) Deprecated.
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	updateDLFileEntry(DLFileEntry dlFileEntry, boolean merge) 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,Fields> fieldsMap, File file, InputStream is, long size, ServiceContext serviceContext)
static void	updateSmallImage(long smallImageId, long largeImageId)
static DLFileEntry	updateStatus(long userId, long fileVersionId, int status, Map<String,Serializable> workflowContext, ServiceContext serviceContext)
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)
                                  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

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(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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

fetchDLFileEntry

public static DLFileEntry fetchDLFileEntry(long fileEntryId)
                                    throws SystemException

Throws:

SystemException

getDLFileEntry

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getDLFileEntryByUuidAndGroupId

public static DLFileEntry getDLFileEntryByUuidAndGroupId(String uuid,
                                                         long groupId)
                                                  throws PortalException,
                                                         SystemException

Returns the document library file entry with the UUID in the group.

Parameters:

uuid - the UUID of document library file entry

groupId - the group id of the document library file entry

Returns:

the document library file entry

Throws:

PortalException - if a document library file entry with the UUID in the group could not be found

SystemException - if a system exception occurred

getDLFileEntries

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

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

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

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

updateDLFileEntry

public static DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry,
                                            boolean merge)
                                     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

merge - whether to merge the document library file entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the document library file entry that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

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

Throws:

PortalException

SystemException

cancelCheckOut

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

Throws:

PortalException

SystemException

checkInFileEntry

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

Throws:

PortalException

SystemException

checkInFileEntry

public static void checkInFileEntry(long userId,
                                    long fileEntryId,
                                    String lockUuid)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(long userId,
                                            long fileEntryId)
                                     throws PortalException,
                                            SystemException

Deprecated. checkOutFileEntry(long, long, ServiceContext)

Throws:

PortalException

SystemException

checkOutFileEntry

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

Throws:

PortalException

SystemException

checkOutFileEntry

public static DLFileEntry checkOutFileEntry(long userId,
                                            long fileEntryId,
                                            String owner,
                                            long expirationTime)
                                     throws PortalException,
                                            SystemException

Deprecated. checkOutFileEntry(long, long, String, long, ServiceContext)

Throws:

PortalException

SystemException

checkOutFileEntry

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

Throws:

PortalException

SystemException

convertExtraSettings

public static void convertExtraSettings(String[] keys)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

copyFileEntryMetadata

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

Throws:

PortalException

SystemException

deleteFileEntries

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

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(long fileEntryId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(long userId,
                                   long fileEntryId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileVersion

public static void deleteFileVersion(long userId,
                                     long fileEntryId,
                                     String version)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

fetchFileEntryByAnyImageId

public static DLFileEntry fetchFileEntryByAnyImageId(long imageId)
                                              throws SystemException

Throws:

SystemException

fetchFileEntryByName

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

Throws:

SystemException

getExtraSettingsFileEntries

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

Throws:

SystemException

getFile

public static File getFile(long userId,
                           long fileEntryId,
                           String version,
                           boolean incrementCounter)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

getFileAsStream

public static InputStream getFileAsStream(long userId,
                                          long fileEntryId,
                                          String version)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getFileAsStream

public static InputStream getFileAsStream(long userId,
                                          long fileEntryId,
                                          String version,
                                          boolean incrementCounter)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getFileEntries

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

Throws:

SystemException

getFileEntries

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

Throws:

SystemException

getFileEntries

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

Throws:

SystemException

getFileEntriesCount

public static int getFileEntriesCount()
                               throws SystemException

Throws:

SystemException

getFileEntriesCount

public static int getFileEntriesCount(long groupId,
                                      long folderId)
                               throws SystemException

Throws:

SystemException

getFileEntry

public static DLFileEntry getFileEntry(long fileEntryId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getFileEntry

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

Throws:

PortalException

SystemException

getFileEntryByName

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

Throws:

PortalException

SystemException

getFileEntryByUuidAndGroupId

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

Throws:

PortalException

SystemException

getGroupFileEntries

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

Throws:

SystemException

getGroupFileEntries

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

Throws:

SystemException

getGroupFileEntries

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

Throws:

SystemException

getGroupFileEntries

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

Throws:

SystemException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId)
                                    throws SystemException

Throws:

SystemException

getGroupFileEntriesCount

public static int getGroupFileEntriesCount(long groupId,
                                           long userId)
                                    throws SystemException

Throws:

SystemException

getMisversionedFileEntries

public static List<DLFileEntry> getMisversionedFileEntries()
                                                    throws SystemException

Throws:

SystemException

getNoAssetFileEntries

public static List<DLFileEntry> getNoAssetFileEntries()
                                               throws SystemException

Throws:

SystemException

getOrphanedFileEntries

public static List<DLFileEntry> getOrphanedFileEntries()
                                                throws SystemException

Throws:

SystemException

hasExtraSettings

public static boolean hasExtraSettings()
                                throws SystemException

Throws:

SystemException

hasFileEntryLock

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

Throws:

PortalException

SystemException

isFileEntryCheckedOut

public static boolean isFileEntryCheckedOut(long fileEntryId)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

moveFileEntry

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

Throws:

PortalException

SystemException

revertFileEntry

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

Throws:

PortalException

SystemException

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

Throws:

PortalException

SystemException

updateSmallImage

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

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException

verifyFileEntryCheckOut

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

Throws:

PortalException

SystemException

verifyFileEntryLock

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

Throws:

PortalException

SystemException

getService

public static DLFileEntryLocalService getService()

setService

public void setService(DLFileEntryLocalService service)

Deprecated.