@ProviderType
public class MessageLocalServiceUtil
extends java.lang.Object
com.liferay.mail.reader.service.impl.MessageLocalServiceImpl 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.MessageLocalService,
com.liferay.mail.reader.service.base.MessageLocalServiceBaseImpl,
com.liferay.mail.reader.service.impl.MessageLocalServiceImpl| Constructor and Description |
|---|
MessageLocalServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static Message |
addMessage(long userId,
long folderId,
java.lang.String sender,
java.lang.String to,
java.lang.String cc,
java.lang.String bcc,
java.util.Date sentDate,
java.lang.String subject,
java.lang.String body,
java.lang.String flags,
long remoteMessageId,
java.lang.String contentType) |
static Message |
addMessage(Message message)
Adds the message to the database.
|
static Message |
createMessage(long messageId)
Creates a new message with the primary key.
|
static Message |
deleteMessage(long messageId)
Deletes the message with the primary key from the database.
|
static Message |
deleteMessage(Message message)
Deletes the message from the database.
|
static void |
deleteMessages(long folderId) |
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 Message |
fetchMessage(long messageId) |
static int |
getAccountUnreadMessagesCount(long accountId) |
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static java.util.List<Message> |
getCompanyMessages(long companyId,
int start,
int end) |
static int |
getCompanyMessagesCount(long companyId) |
static java.util.List<Message> |
getFolderMessages(long folderId) |
static int |
getFolderMessagesCount(long folderId) |
static int |
getFolderUnreadMessagesCount(long folderId) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static Message |
getMessage(long messageId)
Returns the message with the primary key.
|
static Message |
getMessage(long folderId,
long remoteMessageId) |
static java.util.List<Message> |
getMessages(int start,
int end)
Returns a range of all the messages.
|
static int |
getMessagesCount()
Returns the number of messages.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static Message |
getRemoteMessage(long folderId,
boolean oldest) |
static MessageLocalService |
getService() |
static int |
populateMessages(java.util.List<Message> messages,
long folderId,
java.lang.String keywords,
int pageNumber,
int messagesPerPage,
java.lang.String orderByField,
java.lang.String orderByType) |
static Message |
updateContent(long messageId,
java.lang.String body,
java.lang.String flags) |
static Message |
updateFlag(long messageId,
int flag,
boolean value) |
static Message |
updateMessage(long messageId,
long folderId,
java.lang.String sender,
java.lang.String to,
java.lang.String cc,
java.lang.String bcc,
java.util.Date sentDate,
java.lang.String subject,
java.lang.String body,
java.lang.String flags,
long remoteMessageId) |
static Message |
updateMessage(Message message)
Updates the message in the database or adds it if it does not yet exist.
|
public static Message addMessage(Message message)
message - the messagepublic static Message addMessage(long userId, long folderId, java.lang.String sender, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.util.Date sentDate, java.lang.String subject, java.lang.String body, java.lang.String flags, long remoteMessageId, java.lang.String contentType) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static Message createMessage(long messageId)
messageId - the primary key for the new messagepublic static Message deleteMessage(Message message) throws com.liferay.portal.kernel.exception.PortalException
message - the messagePortalExceptionpublic static Message deleteMessage(long messageId) throws com.liferay.portal.kernel.exception.PortalException
messageId - the primary key of the messagePortalException - if a message with the primary key could not be foundpublic static Message fetchMessage(long messageId)
public static Message getMessage(long folderId, long remoteMessageId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static Message getMessage(long messageId) throws com.liferay.portal.kernel.exception.PortalException
messageId - the primary key of the messagePortalException - if a message with the primary key could not be foundpublic static Message getRemoteMessage(long folderId, boolean oldest) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static Message updateContent(long messageId, java.lang.String body, java.lang.String flags) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static Message updateFlag(long messageId, int flag, boolean value) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static Message updateMessage(Message message)
message - the messagepublic static Message updateMessage(long messageId, long folderId, java.lang.String sender, java.lang.String to, java.lang.String cc, java.lang.String bcc, java.util.Date sentDate, java.lang.String subject, java.lang.String body, java.lang.String flags, long remoteMessageId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
throws com.liferay.portal.kernel.exception.PortalException
PortalExceptionpublic static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static int getAccountUnreadMessagesCount(long accountId)
public static int getCompanyMessagesCount(long companyId)
public static int getFolderMessagesCount(long folderId)
public static int getFolderUnreadMessagesCount(long folderId)
public static int getMessagesCount()
public static int populateMessages(java.util.List<Message> messages, long folderId, java.lang.String keywords, int pageNumber, int messagesPerPage, java.lang.String orderByField, java.lang.String orderByType)
public static java.lang.String getOSGiServiceIdentifier()
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 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 com.liferay.mail.reader.model.impl.MessageModelImpl. 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.
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 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 com.liferay.mail.reader.model.impl.MessageModelImpl. 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.
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 java.util.List<Message> getCompanyMessages(long companyId, int start, int end)
public static java.util.List<Message> getFolderMessages(long folderId)
public static java.util.List<Message> getMessages(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 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 com.liferay.mail.reader.model.impl.MessageModelImpl. 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.
start - the lower bound of the range of messagesend - the upper bound of the range of messages (not inclusive)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 void deleteMessages(long folderId)
throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalExceptionpublic static MessageLocalService getService()