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 d l file entry local service. This utility wraps DLFileEntryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to DLFileEntryLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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, DLFileEntryLocalServiceBaseImpl, DLFileEntryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

DLFileEntryLocalServiceUtil()

Method Summary

static DLFileEntry	addDLFileEntry(DLFileEntry dlFileEntry) Adds the d l file entry to the database.
static DLFileEntry	addFileEntry(long userId, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, byte[] bytes, ServiceContext serviceContext)
static DLFileEntry	addFileEntry(long userId, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, File file, ServiceContext serviceContext)
static DLFileEntry	addFileEntry(long userId, long groupId, long folderId, String name, String title, String description, String changeLog, String extraSettings, InputStream is, long size, ServiceContext serviceContext)
static void	addFileEntryResources(DLFileEntry fileEntry, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addFileEntryResources(DLFileEntry fileEntry, String[] communityPermissions, String[] guestPermissions)
static void	addFileEntryResources(long fileEntryId, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addFileEntryResources(long fileEntryId, String[] communityPermissions, String[] guestPermissions)
static DLFileEntry	addOrOverwriteFileEntry(long userId, long groupId, long folderId, String name, String sourceName, String title, String description, String changeLog, String extraSettings, File file, ServiceContext serviceContext)
static DLFileEntry	createDLFileEntry(long fileEntryId) Creates a new d l file entry with the primary key.
static void	deleteDLFileEntry(DLFileEntry dlFileEntry) Deletes the d l file entry from the database.
static void	deleteDLFileEntry(long fileEntryId) Deletes the d l file entry with the primary key from the database.
static void	deleteFileEntries(long groupId, long folderId)
static void	deleteFileEntry(DLFileEntry fileEntry)
static void	deleteFileEntry(long groupId, long folderId, String name)
static void	deleteFileEntry(long groupId, long folderId, String name, String version)
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) Counts the number of rows that match the dynamic query.
static List<DLFileEntry>	getCompanyFileEntries(long companyId, int start, int end)
static List<DLFileEntry>	getCompanyFileEntries(long companyId, int start, int end, OrderByComparator obc)
static int	getCompanyFileEntriesCount(long companyId)
static List<DLFileEntry>	getDLFileEntries(int start, int end) Gets a range of all the d l file entries.
static int	getDLFileEntriesCount() Gets the number of d l file entries.
static DLFileEntry	getDLFileEntry(long fileEntryId) Gets the d l file entry with the primary key.
static DLFileEntry	getDLFileEntryByUuidAndGroupId(String uuid, long groupId) Gets the d l file entry with the UUID and group id.
static InputStream	getFileAsStream(long companyId, long userId, long groupId, long folderId, String name)
static InputStream	getFileAsStream(long companyId, long userId, long groupId, long folderId, String name, String version)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end)
static List<DLFileEntry>	getFileEntries(long groupId, long folderId, int start, int end, OrderByComparator obc)
static int	getFileEntriesCount(long groupId, long folderId)
static DLFileEntry	getFileEntry(long fileEntryId)
static DLFileEntry	getFileEntry(long groupId, long folderId, String name)
static DLFileEntry	getFileEntryByTitle(long groupId, long folderId, String title)
static DLFileEntry	getFileEntryByUuidAndGroupId(String uuid, long groupId)
static int	getFoldersFileEntriesCount(long groupId, List<Long> folderIds, int status)
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>	getNoAssetFileEntries()
static DLFileEntryLocalService	getService()
static DLFileEntry	moveFileEntry(long userId, long groupId, long folderId, long newFolderId, String name, ServiceContext serviceContext)
void	setService(DLFileEntryLocalService service)
static void	updateAsset(long userId, DLFileEntry fileEntry, DLFileVersion fileVersion, long[] assetCategoryIds, String[] assetTagNames)
static DLFileEntry	updateDLFileEntry(DLFileEntry dlFileEntry) Updates the d l file entry in the database.
static DLFileEntry	updateDLFileEntry(DLFileEntry dlFileEntry, boolean merge) Updates the d l file entry in the database.
static DLFileEntry	updateFileEntry(long userId, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, byte[] bytes, ServiceContext serviceContext)
static DLFileEntry	updateFileEntry(long userId, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, File file, ServiceContext serviceContext)
static DLFileEntry	updateFileEntry(long userId, long groupId, long folderId, String name, String sourceFileName, String title, String description, String changeLog, boolean majorVersion, String extraSettings, InputStream is, long size, ServiceContext serviceContext)
static DLFileEntry	updateStatus(long userId, long fileEntryId, int status, ServiceContext serviceContext)

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 d l file entry to the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to add

Returns:

the d l file entry that was added

Throws:

SystemException - if a system exception occurred

createDLFileEntry

public static DLFileEntry createDLFileEntry(long fileEntryId)

Creates a new d l file entry with the primary key. Does not add the d l file entry to the database.

Parameters:

fileEntryId - the primary key for the new d l file entry

Returns:

the new d l file entry

deleteDLFileEntry

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

Deletes the d l file entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

fileEntryId - the primary key of the d l file entry to delete

Throws:

PortalException - if a d l file entry with the primary key could not be found

SystemException - if a system exception occurred

deleteDLFileEntry

public static void deleteDLFileEntry(DLFileEntry dlFileEntry)
                              throws SystemException

Deletes the d l file entry from the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to delete

Throws:

SystemException - if a system exception occurred

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 to search with

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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getDLFileEntry

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

Gets the d l file entry with the primary key.

Parameters:

fileEntryId - the primary key of the d l file entry to get

Returns:

the d l file entry

Throws:

PortalException - if a d l file entry with the primary key could not be found

SystemException - if a system exception occurred

getDLFileEntryByUuidAndGroupId

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

Gets the d l file entry with the UUID and group id.

Parameters:

uuid - the UUID of d l file entry to get

groupId - the group id of the d l file entry to get

Returns:

the d l file entry

Throws:

PortalException - if a d l file entry with the UUID and group id could not be found

SystemException - if a system exception occurred

getDLFileEntries

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

Gets a range of all the d l 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 d l file entries to return

end - the upper bound of the range of d l file entries to return (not inclusive)

Returns:

the range of d l file entries

Throws:

SystemException - if a system exception occurred

getDLFileEntriesCount

public static int getDLFileEntriesCount()
                                 throws SystemException

Gets the number of d l file entries.

Returns:

the number of d l file entries

Throws:

SystemException - if a system exception occurred

updateDLFileEntry

public static DLFileEntry updateDLFileEntry(DLFileEntry dlFileEntry)
                                     throws SystemException

Updates the d l file entry in the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to update

Returns:

the d l 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 d l file entry in the database. Also notifies the appropriate model listeners.

Parameters:

dlFileEntry - the d l file entry to update

merge - whether to merge the d l 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 d l file entry that was updated

Throws:

SystemException - if a system exception occurred

addFileEntry

public static DLFileEntry addFileEntry(long userId,
                                       long groupId,
                                       long folderId,
                                       String name,
                                       String title,
                                       String description,
                                       String changeLog,
                                       String extraSettings,
                                       byte[] bytes,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

addFileEntry

public static DLFileEntry addFileEntry(long userId,
                                       long groupId,
                                       long folderId,
                                       String name,
                                       String title,
                                       String description,
                                       String changeLog,
                                       String extraSettings,
                                       File file,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

addFileEntry

public static DLFileEntry addFileEntry(long userId,
                                       long groupId,
                                       long folderId,
                                       String name,
                                       String title,
                                       String description,
                                       String changeLog,
                                       String extraSettings,
                                       InputStream is,
                                       long size,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

addFileEntryResources

public static void addFileEntryResources(DLFileEntry fileEntry,
                                         boolean addCommunityPermissions,
                                         boolean addGuestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addFileEntryResources

public static void addFileEntryResources(DLFileEntry fileEntry,
                                         String[] communityPermissions,
                                         String[] guestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addFileEntryResources

public static void addFileEntryResources(long fileEntryId,
                                         boolean addCommunityPermissions,
                                         boolean addGuestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addFileEntryResources

public static void addFileEntryResources(long fileEntryId,
                                         String[] communityPermissions,
                                         String[] guestPermissions)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

addOrOverwriteFileEntry

public static DLFileEntry addOrOverwriteFileEntry(long userId,
                                                  long groupId,
                                                  long folderId,
                                                  String name,
                                                  String sourceName,
                                                  String title,
                                                  String description,
                                                  String changeLog,
                                                  String extraSettings,
                                                  File file,
                                                  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(DLFileEntry fileEntry)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(long groupId,
                                   long folderId,
                                   String name)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

deleteFileEntry

public static void deleteFileEntry(long groupId,
                                   long folderId,
                                   String name,
                                   String version)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getCompanyFileEntries

public static List<DLFileEntry> getCompanyFileEntries(long companyId,
                                                      int start,
                                                      int end)
                                               throws SystemException

Throws:

SystemException

getCompanyFileEntries

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

Throws:

SystemException

getCompanyFileEntriesCount

public static int getCompanyFileEntriesCount(long companyId)
                                      throws SystemException

Throws:

SystemException

getFileAsStream

public static InputStream getFileAsStream(long companyId,
                                          long userId,
                                          long groupId,
                                          long folderId,
                                          String name)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getFileAsStream

public static InputStream getFileAsStream(long companyId,
                                          long userId,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String version)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getFileEntries

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

Throws:

SystemException

getFileEntries

public static List<DLFileEntry> getFileEntries(long groupId,
                                               long folderId,
                                               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

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 name)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getFileEntryByTitle

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

Throws:

PortalException

SystemException

getFileEntryByUuidAndGroupId

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

Throws:

PortalException

SystemException

getFoldersFileEntriesCount

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

Throws:

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

getNoAssetFileEntries

public static List<DLFileEntry> getNoAssetFileEntries()
                                               throws SystemException

Throws:

SystemException

moveFileEntry

public static DLFileEntry moveFileEntry(long userId,
                                        long groupId,
                                        long folderId,
                                        long newFolderId,
                                        String name,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

updateAsset

public static void updateAsset(long userId,
                               DLFileEntry fileEntry,
                               DLFileVersion fileVersion,
                               long[] assetCategoryIds,
                               String[] assetTagNames)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

updateFileEntry

public static DLFileEntry updateFileEntry(long userId,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String sourceFileName,
                                          String title,
                                          String description,
                                          String changeLog,
                                          boolean majorVersion,
                                          String extraSettings,
                                          byte[] bytes,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updateFileEntry

public static DLFileEntry updateFileEntry(long userId,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String sourceFileName,
                                          String title,
                                          String description,
                                          String changeLog,
                                          boolean majorVersion,
                                          String extraSettings,
                                          File file,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updateFileEntry

public static DLFileEntry updateFileEntry(long userId,
                                          long groupId,
                                          long folderId,
                                          String name,
                                          String sourceFileName,
                                          String title,
                                          String description,
                                          String changeLog,
                                          boolean majorVersion,
                                          String extraSettings,
                                          InputStream is,
                                          long size,
                                          ServiceContext serviceContext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

updateStatus

public static DLFileEntry updateStatus(long userId,
                                       long fileEntryId,
                                       int status,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getService

public static DLFileEntryLocalService getService()

setService

public void setService(DLFileEntryLocalService service)