MBMessageLocalServiceUtil (Liferay 7.0.10 portal-kernel API)

Object
- com.liferay.message.boards.kernel.service.MBMessageLocalServiceUtil

```
@ProviderType
public class MBMessageLocalServiceUtil
extends Object
```
Provides the local service utility for MBMessage. This utility wraps MBMessageLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

MBMessageLocalService, MBMessageLocalServiceBaseImpl, MBMessageLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors
Constructor and Description

MBMessageLocalServiceUtil()

Constructors
Constructor and Description
`MBMessageLocalServiceUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static MBMessage`	`addDiscussionMessage(long userId, String userName, long groupId, String className, long classPK, int workflowAction)`
`static MBMessage`	`addDiscussionMessage(long userId, String userName, long groupId, String className, long classPK, long threadId, long parentMessageId, String subject, String body, ServiceContext serviceContext)`
`static MBMessage`	`addMBMessage(MBMessage mbMessage)` Adds the message-boards message to the database.
`static MBMessage`	`addMessage(long userId, String userName, long groupId, long categoryId, long threadId, long parentMessageId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)`
`static MBMessage`	`addMessage(long userId, String userName, long groupId, long categoryId, String subject, String body, ServiceContext serviceContext)`
`static MBMessage`	`addMessage(long userId, String userName, long groupId, long categoryId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)`
`static MBMessage`	`addMessage(long userId, String userName, long groupId, long categoryId, String subject, String body, String format, String fileName, File file, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)`
`static MBMessage`	`addMessage(long userId, String userName, long categoryId, String subject, String body, ServiceContext serviceContext)` Deprecated. As of Wilberforce (7.0.x), replaced by `addMessage(long, String, long, long, String, String, ServiceContext)`
`static void`	`addMessageAttachment(long userId, long messageId, String fileName, File file, String mimeType)`
`static void`	`addMessageResources(long messageId, boolean addGroupPermissions, boolean addGuestPermissions)`
`static void`	`addMessageResources(long messageId, ModelPermissions modelPermissions)`
`static void`	`addMessageResources(MBMessage message, boolean addGroupPermissions, boolean addGuestPermissions)`
`static void`	`addMessageResources(MBMessage message, ModelPermissions modelPermissions)`
`static MBMessage`	`createMBMessage(long messageId)` Creates a new message-boards message with the primary key.
`static MBMessage`	`deleteDiscussionMessage(long messageId)`
`static void`	`deleteDiscussionMessages(String className, long classPK)`
`static MBMessage`	`deleteMBMessage(long messageId)` Deletes the message-boards message with the primary key from the database.
`static MBMessage`	`deleteMBMessage(MBMessage mbMessage)` Deletes the message-boards message from the database.
`static MBMessage`	`deleteMessage(long messageId)`
`static MBMessage`	`deleteMessage(MBMessage message)`
`static void`	`deleteMessageAttachment(long messageId, String fileName)`
`static void`	`deleteMessageAttachments(long messageId)`
`static PersistedModel`	`deletePersistedModel(PersistedModel persistedModel)`
`static DynamicQuery`	`dynamicQuery()`
`static <T> List<T>`	`dynamicQuery(DynamicQuery dynamicQuery)` Performs a dynamic query on the database and returns the matching rows.
`static <T> 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> 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 void`	`emptyMessageAttachments(long messageId)`
`static MBMessage`	`fetchMBMessage(long messageId)`
`static MBMessage`	`fetchMBMessageByUuidAndGroupId(String uuid, long groupId)` Returns the message-boards message matching the UUID and group.
`static ActionableDynamicQuery`	`getActionableDynamicQuery()`
`static List<MBMessage>`	`getCategoryMessages(long groupId, long categoryId, int status, int start, int end)`
`static List<MBMessage>`	`getCategoryMessages(long groupId, long categoryId, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static int`	`getCategoryMessagesCount(long groupId, long categoryId, int status)`
`static List<MBMessage>`	`getCompanyMessages(long companyId, int status, int start, int end)`
`static List<MBMessage>`	`getCompanyMessages(long companyId, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static int`	`getCompanyMessagesCount(long companyId, int status)`
`static MBMessageDisplay`	`getDiscussionMessageDisplay(long userId, long groupId, String className, long classPK, int status)`
`static MBMessageDisplay`	`getDiscussionMessageDisplay(long userId, long groupId, String className, long classPK, int status, Comparator<MBMessage> comparator)`
`static MBMessageDisplay`	`getDiscussionMessageDisplay(long userId, long groupId, String className, long classPK, int status, String threadView)` Deprecated. As of Wilberforce (7.0.x), replaced by `getDiscussionMessageDisplay(long, long, String, long, int)`
`static int`	`getDiscussionMessagesCount(long classNameId, long classPK, int status)`
`static int`	`getDiscussionMessagesCount(String className, long classPK, int status)`
`static List<MBDiscussion>`	`getDiscussions(String className)`
`static ExportActionableDynamicQuery`	`getExportActionableDynamicQuery(PortletDataContext portletDataContext)`
`static List<MBMessage>`	`getGroupMessages(long groupId, int status, int start, int end)`
`static List<MBMessage>`	`getGroupMessages(long groupId, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static List<MBMessage>`	`getGroupMessages(long groupId, long userId, int status, int start, int end)`
`static List<MBMessage>`	`getGroupMessages(long groupId, long userId, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static int`	`getGroupMessagesCount(long groupId, int status)`
`static int`	`getGroupMessagesCount(long groupId, long userId, int status)`
`static IndexableActionableDynamicQuery`	`getIndexableActionableDynamicQuery()`
`static MBMessage`	`getMBMessage(long messageId)` Returns the message-boards message with the primary key.
`static MBMessage`	`getMBMessageByUuidAndGroupId(String uuid, long groupId)` Returns the message-boards message matching the UUID and group.
`static List<MBMessage>`	`getMBMessages(int start, int end)` Returns a range of all the message-boards messages.
`static List<MBMessage>`	`getMBMessagesByUuidAndCompanyId(String uuid, long companyId)` Returns all the message-boards messages matching the UUID and company.
`static List<MBMessage>`	`getMBMessagesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBMessage> orderByComparator)` Returns a range of message-boards messages matching the UUID and company.
`static int`	`getMBMessagesCount()` Returns the number of message-boards messages.
`static MBMessage`	`getMessage(long messageId)`
`static MBMessageDisplay`	`getMessageDisplay(long userId, long messageId, int status)`
`static MBMessageDisplay`	`getMessageDisplay(long userId, long messageId, int status, String threadView, boolean includePrevAndNext)` Deprecated. As of Wilberforce (7.0.x), replaced by `getMessageDisplay(long, long, int)`
`static MBMessageDisplay`	`getMessageDisplay(long userId, MBMessage message, int status)`
`static MBMessageDisplay`	`getMessageDisplay(long userId, MBMessage message, int status, Comparator<MBMessage> comparator)`
`static MBMessageDisplay`	`getMessageDisplay(long userId, MBMessage message, int status, String threadView, boolean includePrevAndNext)` Deprecated. As of Wilberforce (7.0.x), replaced by `getMessageDisplay(long, MBMessage, int)`
`static MBMessageDisplay`	`getMessageDisplay(long userId, MBMessage message, int status, String threadView, boolean includePrevAndNext, Comparator<MBMessage> comparator)` Deprecated. As of Wilberforce (7.0.x), replaced by `getMessageDisplay(long, MBMessage, int, Comparator)` (
`static List<MBMessage>`	`getMessages(String className, long classPK, int status)`
`static List<MBMessage>`	`getNoAssetMessages()`
`static String`	`getOSGiServiceIdentifier()` Returns the OSGi service identifier.
`static PersistedModel`	`getPersistedModel(Serializable primaryKeyObj)`
`static int`	`getPositionInThread(long messageId)`
`static MBMessageLocalService`	`getService()`
`static List<MBMessage>`	`getThreadMessages(long threadId, int status)`
`static List<MBMessage>`	`getThreadMessages(long threadId, int status, Comparator<MBMessage> comparator)`
`static List<MBMessage>`	`getThreadMessages(long threadId, int status, int start, int end)`
`static List<MBMessage>`	`getThreadMessages(long userId, long threadId, int status, int start, int end, Comparator<MBMessage> comparator)`
`static int`	`getThreadMessagesCount(long threadId, int status)`
`static List<MBMessage>`	`getThreadRepliesMessages(long threadId, int status, int start, int end)`
`static List<MBMessage>`	`getUserDiscussionMessages(long userId, long[] classNameIds, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static List<MBMessage>`	`getUserDiscussionMessages(long userId, long classNameId, long classPK, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static List<MBMessage>`	`getUserDiscussionMessages(long userId, String className, long classPK, int status, int start, int end, OrderByComparator<MBMessage> obc)`
`static int`	`getUserDiscussionMessagesCount(long userId, long[] classNameIds, int status)`
`static int`	`getUserDiscussionMessagesCount(long userId, long classNameId, long classPK, int status)`
`static int`	`getUserDiscussionMessagesCount(long userId, String className, long classPK, int status)`
`static long`	`moveMessageAttachmentToTrash(long userId, long messageId, String fileName)`
`static void`	`restoreMessageAttachmentFromTrash(long userId, long messageId, String deletedFileName)`
`static void`	`subscribeMessage(long userId, long messageId)`
`static void`	`unsubscribeMessage(long userId, long messageId)`
`static void`	`updateAnswer(long messageId, boolean answer, boolean cascade)`
`static void`	`updateAnswer(MBMessage message, boolean answer, boolean cascade)`
`static void`	`updateAsset(long userId, MBMessage message, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)`
`static MBMessage`	`updateDiscussionMessage(long userId, long messageId, String className, long classPK, String subject, String body, ServiceContext serviceContext)`
`static MBMessage`	`updateMBMessage(MBMessage mbMessage)` Updates the message-boards message in the database or adds it if it does not yet exist.
`static MBMessage`	`updateMessage(long userId, long messageId, String body, ServiceContext serviceContext)`
`static MBMessage`	`updateMessage(long userId, long messageId, String subject, String body, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, List<String> existingFiles, double priority, boolean allowPingbacks, ServiceContext serviceContext)`
`static MBMessage`	`updateMessage(long messageId, String body)` Deprecated. As of Wilberforce (7.0.x), with no direct replacement
`static MBMessage`	`updateStatus(long userId, long messageId, int status, ServiceContext serviceContext)` Deprecated. As of Wilberforce (7.0.x), replaced by `updateStatus(long, long, int, ServiceContext, Map)`
`static MBMessage`	`updateStatus(long userId, long messageId, int status, ServiceContext serviceContext, Map<String,Serializable> workflowContext)`
`static void`	`updateUserName(long userId, String userName)`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- MBMessageLocalServiceUtil
```
public MBMessageLocalServiceUtil()
```

Method Detail

addDiscussionMessage

public static MBMessage addDiscussionMessage(long userId,
                                             String userName,
                                             long groupId,
                                             String className,
                                             long classPK,
                                             int workflowAction)
                                      throws PortalException

Throws:: PortalException

addDiscussionMessage

public static MBMessage addDiscussionMessage(long userId,
                                             String userName,
                                             long groupId,
                                             String className,
                                             long classPK,
                                             long threadId,
                                             long parentMessageId,
                                             String subject,
                                             String body,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:: PortalException

addMBMessage
```
public static MBMessage addMBMessage(MBMessage mbMessage)
```
Adds the message-boards message to the database. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message

Returns:

the message-boards message that was added

addMessage

public static MBMessage addMessage(long userId,
                                   String userName,
                                   long groupId,
                                   long categoryId,
                                   long threadId,
                                   long parentMessageId,
                                   String subject,
                                   String body,
                                   String format,
                                   List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException

Throws:: PortalException

addMessage

public static MBMessage addMessage(long userId,
                                   String userName,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   ServiceContext serviceContext)
                            throws PortalException

Throws:: PortalException

addMessage

public static MBMessage addMessage(long userId,
                                   String userName,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   String format,
                                   List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException

Throws:: PortalException

addMessage

public static MBMessage addMessage(long userId,
                                   String userName,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   String format,
                                   String fileName,
                                   File file,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws FileNotFoundException,
                                   PortalException

Throws:: FileNotFoundException; PortalException

addMessage

@Deprecated
public static MBMessage addMessage(long userId,
                                               String userName,
                                               long categoryId,
                                               String subject,
                                               String body,
                                               ServiceContext serviceContext)
                                        throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by

addMessage(long, String, long, long, String, String,
	ServiceContext)

Throws:: PortalException

addMessageAttachment

public static void addMessageAttachment(long userId,
                                        long messageId,
                                        String fileName,
                                        File file,
                                        String mimeType)
                                 throws PortalException

Throws:: PortalException

addMessageResources

public static void addMessageResources(long messageId,
                                       boolean addGroupPermissions,
                                       boolean addGuestPermissions)
                                throws PortalException

Throws:: PortalException

addMessageResources

public static void addMessageResources(long messageId,
                                       ModelPermissions modelPermissions)
                                throws PortalException

Throws:: PortalException

addMessageResources

public static void addMessageResources(MBMessage message,
                                       boolean addGroupPermissions,
                                       boolean addGuestPermissions)
                                throws PortalException

Throws:: PortalException

addMessageResources

public static void addMessageResources(MBMessage message,
                                       ModelPermissions modelPermissions)
                                throws PortalException

Throws:: PortalException

createMBMessage
```
public static MBMessage createMBMessage(long messageId)
```
Creates a new message-boards message with the primary key. Does not add the message-boards message to the database.

Parameters:

messageId - the primary key for the new message-boards message

Returns:

the new message-boards message

deleteDiscussionMessage

public static MBMessage deleteDiscussionMessage(long messageId)
                                         throws PortalException

Throws:: PortalException

deleteDiscussionMessages

public static void deleteDiscussionMessages(String className,
                                            long classPK)
                                     throws PortalException

Throws:: PortalException

deleteMBMessage
```
public static MBMessage deleteMBMessage(long messageId)
                                 throws PortalException
```
Deletes the message-boards message with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

messageId - the primary key of the message-boards message

Returns:

the message-boards message that was removed

Throws:

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

deleteMBMessage
```
public static MBMessage deleteMBMessage(MBMessage mbMessage)
```
Deletes the message-boards message from the database. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message

Returns:

the message-boards message that was removed

deleteMessage

public static MBMessage deleteMessage(long messageId)
                               throws PortalException

Throws:: PortalException

deleteMessage

public static MBMessage deleteMessage(MBMessage message)
                               throws PortalException

Throws:: PortalException

deleteMessageAttachment

public static void deleteMessageAttachment(long messageId,
                                           String fileName)
                                    throws PortalException

Throws:: PortalException

deleteMessageAttachments

public static void deleteMessageAttachments(long messageId)
                                     throws PortalException

Throws:: PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:: PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery
```
public static <T> 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> 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 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 MBMessageModelImpl. 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.

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> 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 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 MBMessageModelImpl. 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.

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

emptyMessageAttachments

public static void emptyMessageAttachments(long messageId)
                                    throws PortalException

Throws:: PortalException

fetchMBMessage

public static MBMessage fetchMBMessage(long messageId)

fetchMBMessageByUuidAndGroupId
```
public static MBMessage fetchMBMessageByUuidAndGroupId(String uuid,
                                                       long groupId)
```
Returns the message-boards message matching the UUID and group.

Parameters:

uuid - the message-boards message's UUID

groupId - the primary key of the group

Returns:

the matching message-boards message, or null if a matching message-boards message could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCategoryMessages

public static List<MBMessage> getCategoryMessages(long groupId,
                                                  long categoryId,
                                                  int status,
                                                  int start,
                                                  int end)

getCategoryMessages

public static List<MBMessage> getCategoryMessages(long groupId,
                                                  long categoryId,
                                                  int status,
                                                  int start,
                                                  int end,
                                                  OrderByComparator<MBMessage> obc)

getCategoryMessagesCount

public static int getCategoryMessagesCount(long groupId,
                                           long categoryId,
                                           int status)

getCompanyMessages

public static List<MBMessage> getCompanyMessages(long companyId,
                                                 int status,
                                                 int start,
                                                 int end)

getCompanyMessages

public static List<MBMessage> getCompanyMessages(long companyId,
                                                 int status,
                                                 int start,
                                                 int end,
                                                 OrderByComparator<MBMessage> obc)

getCompanyMessagesCount

public static int getCompanyMessagesCount(long companyId,
                                          int status)

getDiscussionMessageDisplay

public static MBMessageDisplay getDiscussionMessageDisplay(long userId,
                                                           long groupId,
                                                           String className,
                                                           long classPK,
                                                           int status)
                                                    throws PortalException

Throws:: PortalException

getDiscussionMessageDisplay

public static MBMessageDisplay getDiscussionMessageDisplay(long userId,
                                                           long groupId,
                                                           String className,
                                                           long classPK,
                                                           int status,
                                                           Comparator<MBMessage> comparator)
                                                    throws PortalException

Throws:: PortalException

getDiscussionMessageDisplay

@Deprecated
public static MBMessageDisplay getDiscussionMessageDisplay(long userId,
                                                                       long groupId,
                                                                       String className,
                                                                       long classPK,
                                                                       int status,
                                                                       String threadView)
                                                                throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getDiscussionMessageDisplay(long, long, String, long, int)

Throws:: PortalException

getDiscussionMessagesCount

public static int getDiscussionMessagesCount(long classNameId,
                                             long classPK,
                                             int status)

getDiscussionMessagesCount

public static int getDiscussionMessagesCount(String className,
                                             long classPK,
                                             int status)

getDiscussions

public static List<MBDiscussion> getDiscussions(String className)

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getGroupMessages

public static List<MBMessage> getGroupMessages(long groupId,
                                               int status,
                                               int start,
                                               int end)

getGroupMessages

public static List<MBMessage> getGroupMessages(long groupId,
                                               int status,
                                               int start,
                                               int end,
                                               OrderByComparator<MBMessage> obc)

getGroupMessages

public static List<MBMessage> getGroupMessages(long groupId,
                                               long userId,
                                               int status,
                                               int start,
                                               int end)

getGroupMessages

public static List<MBMessage> getGroupMessages(long groupId,
                                               long userId,
                                               int status,
                                               int start,
                                               int end,
                                               OrderByComparator<MBMessage> obc)

getGroupMessagesCount

public static int getGroupMessagesCount(long groupId,
                                        int status)

getGroupMessagesCount

public static int getGroupMessagesCount(long groupId,
                                        long userId,
                                        int status)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMBMessage
```
public static MBMessage getMBMessage(long messageId)
                              throws PortalException
```
Returns the message-boards message with the primary key.

Parameters:

messageId - the primary key of the message-boards message

Returns:

the message-boards message

Throws:

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

getMBMessageByUuidAndGroupId
```
public static MBMessage getMBMessageByUuidAndGroupId(String uuid,
                                                     long groupId)
                                              throws PortalException
```
Returns the message-boards message matching the UUID and group.

Parameters:

uuid - the message-boards message's UUID

groupId - the primary key of the group

Returns:

the matching message-boards message

Throws:

PortalException - if a matching message-boards message could not be found

getMBMessages
```
public static List<MBMessage> getMBMessages(int start,
                                            int end)
```
Returns a range of all the message-boards messages.
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 MBMessageModelImpl. 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.

Parameters:

start - the lower bound of the range of message-boards messages

end - the upper bound of the range of message-boards messages (not inclusive)

Returns:

the range of message-boards messages

getMBMessagesByUuidAndCompanyId
```
public static List<MBMessage> getMBMessagesByUuidAndCompanyId(String uuid,
                                                              long companyId)
```
Returns all the message-boards messages matching the UUID and company.

Parameters:

uuid - the UUID of the message-boards messages

companyId - the primary key of the company

Returns:

the matching message-boards messages, or an empty list if no matches were found

getMBMessagesByUuidAndCompanyId
```
public static List<MBMessage> getMBMessagesByUuidAndCompanyId(String uuid,
                                                              long companyId,
                                                              int start,
                                                              int end,
                                                              OrderByComparator<MBMessage> orderByComparator)
```
Returns a range of message-boards messages matching the UUID and company.

Parameters:

uuid - the UUID of the message-boards messages

companyId - the primary key of the company

start - the lower bound of the range of message-boards messages

end - the upper bound of the range of message-boards messages (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching message-boards messages, or an empty list if no matches were found

getMBMessagesCount
```
public static int getMBMessagesCount()
```
Returns the number of message-boards messages.

Returns:

the number of message-boards messages

getMessage

public static MBMessage getMessage(long messageId)
                            throws PortalException

Throws:: PortalException

getMessageDisplay

public static MBMessageDisplay getMessageDisplay(long userId,
                                                 long messageId,
                                                 int status)
                                          throws PortalException

Throws:: PortalException

getMessageDisplay

@Deprecated
public static MBMessageDisplay getMessageDisplay(long userId,
                                                             long messageId,
                                                             int status,
                                                             String threadView,
                                                             boolean includePrevAndNext)
                                                      throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getMessageDisplay(long, long, int)

Throws:: PortalException

getMessageDisplay

public static MBMessageDisplay getMessageDisplay(long userId,
                                                 MBMessage message,
                                                 int status)
                                          throws PortalException

Throws:: PortalException

getMessageDisplay

public static MBMessageDisplay getMessageDisplay(long userId,
                                                 MBMessage message,
                                                 int status,
                                                 Comparator<MBMessage> comparator)
                                          throws PortalException

Throws:: PortalException

getMessageDisplay

@Deprecated
public static MBMessageDisplay getMessageDisplay(long userId,
                                                             MBMessage message,
                                                             int status,
                                                             String threadView,
                                                             boolean includePrevAndNext)
                                                      throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getMessageDisplay(long, MBMessage, int)

Throws:: PortalException

getMessageDisplay

@Deprecated
public static MBMessageDisplay getMessageDisplay(long userId,
                                                             MBMessage message,
                                                             int status,
                                                             String threadView,
                                                             boolean includePrevAndNext,
                                                             Comparator<MBMessage> comparator)
                                                      throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by getMessageDisplay(long, MBMessage, int, Comparator) (

Throws:: PortalException

getMessages

public static List<MBMessage> getMessages(String className,
                                          long classPK,
                                          int status)

getNoAssetMessages

public static List<MBMessage> getNoAssetMessages()

getOSGiServiceIdentifier
```
public static String getOSGiServiceIdentifier()
```
Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:: PortalException

getPositionInThread

public static int getPositionInThread(long messageId)
                               throws PortalException

Throws:: PortalException

getThreadMessages

public static List<MBMessage> getThreadMessages(long threadId,
                                                int status)

getThreadMessages

public static List<MBMessage> getThreadMessages(long threadId,
                                                int status,
                                                Comparator<MBMessage> comparator)

getThreadMessages

public static List<MBMessage> getThreadMessages(long threadId,
                                                int status,
                                                int start,
                                                int end)

getThreadMessages

public static List<MBMessage> getThreadMessages(long userId,
                                                long threadId,
                                                int status,
                                                int start,
                                                int end,
                                                Comparator<MBMessage> comparator)

getThreadMessagesCount

public static int getThreadMessagesCount(long threadId,
                                         int status)

getThreadRepliesMessages

public static List<MBMessage> getThreadRepliesMessages(long threadId,
                                                       int status,
                                                       int start,
                                                       int end)

getUserDiscussionMessages

public static List<MBMessage> getUserDiscussionMessages(long userId,
                                                        long classNameId,
                                                        long classPK,
                                                        int status,
                                                        int start,
                                                        int end,
                                                        OrderByComparator<MBMessage> obc)

getUserDiscussionMessages

public static List<MBMessage> getUserDiscussionMessages(long userId,
                                                        long[] classNameIds,
                                                        int status,
                                                        int start,
                                                        int end,
                                                        OrderByComparator<MBMessage> obc)

getUserDiscussionMessages

public static List<MBMessage> getUserDiscussionMessages(long userId,
                                                        String className,
                                                        long classPK,
                                                        int status,
                                                        int start,
                                                        int end,
                                                        OrderByComparator<MBMessage> obc)

getUserDiscussionMessagesCount

public static int getUserDiscussionMessagesCount(long userId,
                                                 long classNameId,
                                                 long classPK,
                                                 int status)

getUserDiscussionMessagesCount

public static int getUserDiscussionMessagesCount(long userId,
                                                 long[] classNameIds,
                                                 int status)

getUserDiscussionMessagesCount

public static int getUserDiscussionMessagesCount(long userId,
                                                 String className,
                                                 long classPK,
                                                 int status)

moveMessageAttachmentToTrash

public static long moveMessageAttachmentToTrash(long userId,
                                                long messageId,
                                                String fileName)
                                         throws PortalException

Throws:: PortalException

restoreMessageAttachmentFromTrash

public static void restoreMessageAttachmentFromTrash(long userId,
                                                     long messageId,
                                                     String deletedFileName)
                                              throws PortalException

Throws:: PortalException

subscribeMessage

public static void subscribeMessage(long userId,
                                    long messageId)
                             throws PortalException

Throws:: PortalException

unsubscribeMessage

public static void unsubscribeMessage(long userId,
                                      long messageId)
                               throws PortalException

Throws:: PortalException

updateAnswer

public static void updateAnswer(long messageId,
                                boolean answer,
                                boolean cascade)
                         throws PortalException

Throws:: PortalException

updateAnswer

public static void updateAnswer(MBMessage message,
                                boolean answer,
                                boolean cascade)
                         throws PortalException

Throws:: PortalException

updateAsset

public static void updateAsset(long userId,
                               MBMessage message,
                               long[] assetCategoryIds,
                               String[] assetTagNames,
                               long[] assetLinkEntryIds)
                        throws PortalException

Throws:: PortalException

updateDiscussionMessage

public static MBMessage updateDiscussionMessage(long userId,
                                                long messageId,
                                                String className,
                                                long classPK,
                                                String subject,
                                                String body,
                                                ServiceContext serviceContext)
                                         throws PortalException

Throws:: PortalException

updateMBMessage
```
public static MBMessage updateMBMessage(MBMessage mbMessage)
```
Updates the message-boards message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message

Returns:

the message-boards message that was updated

updateMessage

public static MBMessage updateMessage(long userId,
                                      long messageId,
                                      String body,
                                      ServiceContext serviceContext)
                               throws PortalException

Throws:: PortalException

updateMessage

public static MBMessage updateMessage(long userId,
                                      long messageId,
                                      String subject,
                                      String body,
                                      List<ObjectValuePair<String,InputStream>> inputStreamOVPs,
                                      List<String> existingFiles,
                                      double priority,
                                      boolean allowPingbacks,
                                      ServiceContext serviceContext)
                               throws PortalException

Throws:: PortalException

updateMessage

@Deprecated
public static MBMessage updateMessage(long messageId,
                                                  String body)
                                           throws PortalException

Deprecated. As of Wilberforce (7.0.x), with no direct replacement

Throws:: PortalException

updateStatus

@Deprecated
public static MBMessage updateStatus(long userId,
                                                 long messageId,
                                                 int status,
                                                 ServiceContext serviceContext)
                                          throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by updateStatus(long, long, int, ServiceContext, Map)

Throws:: PortalException

updateStatus

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

Throws:: PortalException

updateUserName

public static void updateUserName(long userId,
                                  String userName)

getService

public static MBMessageLocalService getService()

Class MBMessageLocalServiceUtil

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

MBMessageLocalServiceUtil

Method Detail

addDiscussionMessage

addDiscussionMessage

addMBMessage

addMessage

addMessage

addMessage

addMessage

addMessage

addMessageAttachment

addMessageResources

addMessageResources

addMessageResources

addMessageResources

createMBMessage

deleteDiscussionMessage

deleteDiscussionMessages

deleteMBMessage

deleteMBMessage

deleteMessage

deleteMessage

deleteMessageAttachment

deleteMessageAttachments

deletePersistedModel

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQuery

dynamicQueryCount

dynamicQueryCount

emptyMessageAttachments

fetchMBMessage

fetchMBMessageByUuidAndGroupId

getActionableDynamicQuery

getCategoryMessages

getCategoryMessages

getCategoryMessagesCount

getCompanyMessages

getCompanyMessages

getCompanyMessagesCount

getDiscussionMessageDisplay

getDiscussionMessageDisplay

getDiscussionMessageDisplay

getDiscussionMessagesCount

getDiscussionMessagesCount

getDiscussions

getExportActionableDynamicQuery

getGroupMessages

getGroupMessages

getGroupMessages

getGroupMessages

getGroupMessagesCount

getGroupMessagesCount

getIndexableActionableDynamicQuery

getMBMessage

getMBMessageByUuidAndGroupId

getMBMessages

getMBMessagesByUuidAndCompanyId

getMBMessagesByUuidAndCompanyId

getMBMessagesCount

getMessage

getMessageDisplay

getMessageDisplay

getMessageDisplay

getMessageDisplay

getMessageDisplay

getMessageDisplay

getMessages

getNoAssetMessages

getOSGiServiceIdentifier

getPersistedModel

getPositionInThread

getThreadMessages

getThreadMessages