public class FolderLocalServiceUtil
extends java.lang.Object
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.FolderLocalService
Constructor and Description |
---|
FolderLocalServiceUtil() |
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 com.liferay.portal.kernel.model.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 com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
static Folder |
fetchFolder(long folderId) |
static com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.model.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) |
public static Folder addFolder(Folder folder)
folder
- the folderpublic static Folder addFolder(long userId, long accountId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Folder createFolder(long folderId)
folderId
- the primary key for the new folderpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static Folder deleteFolder(Folder folder) throws com.liferay.portal.kernel.exception.PortalException
folder
- the folderPortalException
public static Folder deleteFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
folderId
- the primary key of the folderPortalException
- if a folder with the primary key could not be foundpublic static void deleteFolders(long accountId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static Folder fetchFolder(long folderId)
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static Folder getFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
folderId
- the primary key of the folderPortalException
- if a folder with the primary key could not be foundpublic static Folder getFolder(long accountId, java.lang.String fullName) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static java.util.List<Folder> getFolders(int start, int end)
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
.
start
- the lower bound of the range of foldersend
- the upper bound of the range of folders (not inclusive)public static java.util.List<Folder> getFolders(long accountId)
public static int getFoldersCount()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static int getLocalPageCount(long folderId, int messagesPerPage)
public static java.lang.String getOSGiServiceIdentifier()
public static int getPercentDownloaded(long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static int getRemotePageCount(long folderId, int messagesPerPage) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static Folder updateFolder(Folder folder)
folder
- the folderpublic static Folder updateFolder(long folderId, java.lang.String fullName, java.lang.String displayName, int remoteMessageCount) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static FolderLocalService getService()