com.liferay.mail.reader.service

Class FolderLocalServiceUtil

java.lang.Object

com.liferay.mail.reader.service.FolderLocalServiceUtil

public class FolderLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Folder. This utility wraps com.liferay.mail.reader.service.impl.FolderLocalServiceImpl and is an 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:

FolderLocalService

Constructor Summary

Constructors

Constructor and Description
FolderLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Folder	addFolder(Folder folder) Adds the folder to the database.
static Folder	addFolder(long userId, long accountId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount)
static Folder	createFolder(long folderId) Creates a new folder with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static Folder	deleteFolder(Folder folder) Deletes the folder from the database.
static Folder	deleteFolder(long folderId) Deletes the folder with the primary key from the database.
static void	deleteFolders(long accountId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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> java.util.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 Folder	fetchFolder(long folderId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static Folder	getFolder(long folderId) Returns the folder with the primary key.
static Folder	getFolder(long accountId, java.lang.String fullName)
static java.util.List<Folder>	getFolders(int start, int end) Returns a range of all the folders.
static java.util.List<Folder>	getFolders(long accountId)
static int	getFoldersCount() Returns the number of folders.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static int	getLocalPageCount(long folderId, int messagesPerPage)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static int	getPercentDownloaded(long folderId)
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static int	getRemotePageCount(long folderId, int messagesPerPage)
static FolderLocalService	getService()
static Folder	updateFolder(Folder folder) Updates the folder in the database or adds it if it does not yet exist.
static Folder	updateFolder(long folderId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderLocalServiceUtil

public FolderLocalServiceUtil()

Method Detail

addFolder

public static Folder addFolder(Folder folder)

Adds the folder to the database. Also notifies the appropriate model listeners.

Important: Inspect FolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

folder - the folder

Returns:

the folder that was added

addFolder

public static Folder addFolder(long userId,
                               long accountId,
                               java.lang.String fullName,
                               java.lang.String displayName,
                               int remoteMessageCount)
                        throws PortalException

Throws:

PortalException

createFolder

public static Folder createFolder(long folderId)

Creates a new folder with the primary key. Does not add the folder to the database.

Parameters:

folderId - the primary key for the new folder

Returns:

the new folder

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteFolder

public static Folder deleteFolder(Folder folder)
                           throws PortalException

Deletes the folder from the database. Also notifies the appropriate model listeners.

Important: Inspect FolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

folder - the folder

Returns:

the folder that was removed

Throws:

PortalException

deleteFolder

public static Folder deleteFolder(long folderId)
                           throws PortalException

Deletes the folder with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect FolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

folderId - the primary key of the folder

Returns:

the folder that was removed

Throws:

PortalException - if a folder with the primary key could not be found

deleteFolders

public static void deleteFolders(long accountId)
                          throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.FolderModelImpl.

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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.FolderModelImpl.

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

fetchFolder

public static Folder fetchFolder(long folderId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getFolder

public static Folder getFolder(long folderId)
                        throws PortalException

Returns the folder with the primary key.

Parameters:

folderId - the primary key of the folder

Returns:

the folder

Throws:

PortalException - if a folder with the primary key could not be found

getFolder

public static Folder getFolder(long accountId,
                               java.lang.String fullName)
                        throws PortalException

Throws:

PortalException

getFolders

public static java.util.List<Folder> getFolders(int start,
                                                int end)

Returns a range of all the folders.

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.mail.reader.model.impl.FolderModelImpl.

Parameters:

start - the lower bound of the range of folders

end - the upper bound of the range of folders (not inclusive)

Returns:

the range of folders

getFolders

public static java.util.List<Folder> getFolders(long accountId)

getFoldersCount

public static int getFoldersCount()

Returns the number of folders.

Returns:

the number of folders

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLocalPageCount

public static int getLocalPageCount(long folderId,
                                    int messagesPerPage)

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPercentDownloaded

public static int getPercentDownloaded(long folderId)
                                throws PortalException

Throws:

PortalException

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getRemotePageCount

public static int getRemotePageCount(long folderId,
                                     int messagesPerPage)
                              throws PortalException

Throws:

PortalException

updateFolder

public static Folder updateFolder(Folder folder)

Updates the folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect FolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

folder - the folder

Returns:

the folder that was updated

updateFolder

public static Folder updateFolder(long folderId,
                                  java.lang.String fullName,
                                  java.lang.String displayName,
                                  int remoteMessageCount)
                           throws PortalException

Throws:

PortalException

getService

public static FolderLocalService getService()