com.liferay.portlet.messageboards.service
Class MBMessageLocalServiceUtil

java.lang.Object
  com.liferay.portlet.messageboards.service.MBMessageLocalServiceUtil

public class MBMessageLocalServiceUtil
extends Object

The utility for the message-boards message local service. This utility wraps MBMessageLocalServiceImpl 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 MBMessageLocalServiceImpl 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:

MBMessageLocalService, MBMessageLocalServiceBaseImpl, MBMessageLocalServiceImpl

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

Constructor Summary

MBMessageLocalServiceUtil()

Method Summary

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, List<ObjectValuePair<String,byte[]>> files, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
static MBMessage	addMessage(long userId, String userName, long groupId, long categoryId, String subject, String body, List<ObjectValuePair<String,byte[]>> files, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
static void	addMessageResources(long messageId, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addMessageResources(long messageId, String[] communityPermissions, String[] guestPermissions)
static void	addMessageResources(MBMessage message, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addMessageResources(MBMessage message, String[] communityPermissions, String[] guestPermissions)
static MBMessage	createMBMessage(long messageId) Creates a new message-boards message with the primary key.
static void	deleteDiscussionMessage(long messageId)
static void	deleteDiscussionMessages(String className, long classPK)
static void	deleteMBMessage(long messageId) Deletes the message-boards message with the primary key from the database.
static void	deleteMBMessage(MBMessage mbMessage) Deletes the message-boards message from the database.
static void	deleteMessage(long messageId)
static void	deleteMessage(MBMessage message)
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<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 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 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, String threadView)
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 List<MBMessage>	getGroupMessages(long groupId, int status, int start, int end)
static List<MBMessage>	getGroupMessages(long groupId, int status, int start, int end, OrderByComparator 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 obc)
static int	getGroupMessagesCount(long groupId, int status)
static int	getGroupMessagesCount(long groupId, long userId, int status)
static MBMessage	getMBMessage(long messageId) Gets the message-boards message with the primary key.
static MBMessage	getMBMessageByUuidAndGroupId(String uuid, long groupId) Gets the message-boards message with the UUID and group id.
static List<MBMessage>	getMBMessages(int start, int end) Gets a range of all the message-boards messages.
static int	getMBMessagesCount() Gets the number of message-boards messages.
static MBMessage	getMessage(long messageId)
static MBMessageDisplay	getMessageDisplay(long messageId, int status, String threadView, boolean includePrevAndNext)
static MBMessageDisplay	getMessageDisplay(MBMessage message, int status, String threadView, boolean includePrevAndNext)
static List<MBMessage>	getMessages(String className, long classPK, int status)
static List<MBMessage>	getNoAssetMessages()
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 int	getThreadMessagesCount(long threadId, int status)
static List<MBMessage>	getThreadRepliesMessages(long threadId, int status, int start, int end)
void	setService(MBMessageLocalService service)
static void	subscribeMessage(long userId, long messageId)
static void	unsubscribeMessage(long userId, long messageId)
static void	updateAsset(long userId, MBMessage message, long[] assetCategoryIds, String[] assetTagNames)
static MBMessage	updateDiscussionMessage(long userId, long messageId, String subject, String body, int workflowAction)
static MBMessage	updateMBMessage(MBMessage mbMessage) Updates the message-boards message in the database.
static MBMessage	updateMBMessage(MBMessage mbMessage, boolean merge) Updates the message-boards message in the database.
static MBMessage	updateMessage(long userId, long messageId, String subject, String body, List<ObjectValuePair<String,byte[]>> files, List<String> existingFiles, double priority, boolean allowPingbacks, ServiceContext serviceContext)
static MBMessage	updateMessage(long messageId, String body)
static MBMessage	updateStatus(long userId, long messageId, int status, ServiceContext serviceContext)
static void	updateUserName(long userId, String userName)

Methods inherited from class java.lang.Object

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

Constructor Detail

MBMessageLocalServiceUtil

public MBMessageLocalServiceUtil()

Method Detail

addMBMessage

public static MBMessage addMBMessage(MBMessage mbMessage)
                              throws SystemException

Adds the message-boards message to the database. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message to add

Returns:

the message-boards message that was added

Throws:

SystemException - if a system exception occurred

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

deleteMBMessage

public static void deleteMBMessage(long messageId)
                            throws PortalException,
                                   SystemException

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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteMBMessage

public static void deleteMBMessage(MBMessage mbMessage)
                            throws SystemException

Deletes the message-boards message from the database. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message 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

getMBMessage

public static MBMessage getMBMessage(long messageId)
                              throws PortalException,
                                     SystemException

Gets the message-boards message with the primary key.

Parameters:

messageId - the primary key of the message-boards message to get

Returns:

the message-boards message

Throws:

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

SystemException - if a system exception occurred

getMBMessageByUuidAndGroupId

public static MBMessage getMBMessageByUuidAndGroupId(String uuid,
                                                     long groupId)
                                              throws PortalException,
                                                     SystemException

Gets the message-boards message with the UUID and group id.

Parameters:

uuid - the UUID of message-boards message to get

groupId - the group id of the message-boards message to get

Returns:

the message-boards message

Throws:

PortalException - if a message-boards message with the UUID and group id could not be found

SystemException - if a system exception occurred

getMBMessages

public static List<MBMessage> getMBMessages(int start,
                                            int end)
                                     throws SystemException

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

Parameters:

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

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

Returns:

the range of message-boards messages

Throws:

SystemException - if a system exception occurred

getMBMessagesCount

public static int getMBMessagesCount()
                              throws SystemException

Gets the number of message-boards messages.

Returns:

the number of message-boards messages

Throws:

SystemException - if a system exception occurred

updateMBMessage

public static MBMessage updateMBMessage(MBMessage mbMessage)
                                 throws SystemException

Updates the message-boards message in the database. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message to update

Returns:

the message-boards message that was updated

Throws:

SystemException - if a system exception occurred

updateMBMessage

public static MBMessage updateMBMessage(MBMessage mbMessage,
                                        boolean merge)
                                 throws SystemException

Updates the message-boards message in the database. Also notifies the appropriate model listeners.

Parameters:

mbMessage - the message-boards message to update

merge - whether to merge the message-boards message 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 message-boards message that was updated

Throws:

SystemException - if a system exception occurred

addDiscussionMessage

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

Throws:

PortalException

SystemException

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,
                                             SystemException

Throws:

PortalException

SystemException

addMessage

public static MBMessage addMessage(long userId,
                                   String userName,
                                   long groupId,
                                   long categoryId,
                                   long threadId,
                                   long parentMessageId,
                                   String subject,
                                   String body,
                                   List<ObjectValuePair<String,byte[]>> files,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

addMessage

public static MBMessage addMessage(long userId,
                                   String userName,
                                   long groupId,
                                   long categoryId,
                                   String subject,
                                   String body,
                                   List<ObjectValuePair<String,byte[]>> files,
                                   boolean anonymous,
                                   double priority,
                                   boolean allowPingbacks,
                                   ServiceContext serviceContext)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

addMessageResources

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

Throws:

PortalException

SystemException

addMessageResources

public static void addMessageResources(long messageId,
                                       String[] communityPermissions,
                                       String[] guestPermissions)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

addMessageResources

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

Throws:

PortalException

SystemException

addMessageResources

public static void addMessageResources(MBMessage message,
                                       String[] communityPermissions,
                                       String[] guestPermissions)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

deleteDiscussionMessage

public static void deleteDiscussionMessage(long messageId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteDiscussionMessages

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

Throws:

PortalException

SystemException

deleteMessage

public static void deleteMessage(long messageId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteMessage

public static void deleteMessage(MBMessage message)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getCategoryMessages

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

Throws:

SystemException

getCategoryMessages

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

Throws:

SystemException

getCategoryMessagesCount

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

Throws:

SystemException

getCompanyMessages

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

Throws:

SystemException

getCompanyMessages

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

Throws:

SystemException

getCompanyMessagesCount

public static int getCompanyMessagesCount(long companyId,
                                          int status)
                                   throws SystemException

Throws:

SystemException

getDiscussionMessageDisplay

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

Throws:

PortalException

SystemException

getDiscussionMessageDisplay

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

Throws:

PortalException

SystemException

getDiscussionMessagesCount

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

Throws:

SystemException

getDiscussionMessagesCount

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

Throws:

SystemException

getDiscussions

public static List<MBDiscussion> getDiscussions(String className)
                                         throws SystemException

Throws:

SystemException

getGroupMessages

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

Throws:

SystemException

getGroupMessages

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

Throws:

SystemException

getGroupMessages

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

Throws:

SystemException

getGroupMessages

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

Throws:

SystemException

getGroupMessagesCount

public static int getGroupMessagesCount(long groupId,
                                        int status)
                                 throws SystemException

Throws:

SystemException

getGroupMessagesCount

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

Throws:

SystemException

getMessage

public static MBMessage getMessage(long messageId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getMessageDisplay

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

Throws:

PortalException

SystemException

getMessageDisplay

public static MBMessageDisplay getMessageDisplay(MBMessage message,
                                                 int status,
                                                 String threadView,
                                                 boolean includePrevAndNext)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

getMessages

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

Throws:

SystemException

getNoAssetMessages

public static List<MBMessage> getNoAssetMessages()
                                          throws SystemException

Throws:

SystemException

getPositionInThread

public static int getPositionInThread(long messageId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getThreadMessages

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

Throws:

SystemException

getThreadMessages

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

Throws:

SystemException

getThreadMessages

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

Throws:

SystemException

getThreadMessagesCount

public static int getThreadMessagesCount(long threadId,
                                         int status)
                                  throws SystemException

Throws:

SystemException

getThreadRepliesMessages

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

Throws:

SystemException

subscribeMessage

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

Throws:

PortalException

SystemException

unsubscribeMessage

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateDiscussionMessage

public static MBMessage updateDiscussionMessage(long userId,
                                                long messageId,
                                                String subject,
                                                String body,
                                                int workflowAction)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

updateMessage

public static MBMessage updateMessage(long userId,
                                      long messageId,
                                      String subject,
                                      String body,
                                      List<ObjectValuePair<String,byte[]>> files,
                                      List<String> existingFiles,
                                      double priority,
                                      boolean allowPingbacks,
                                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

updateMessage

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

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException

updateUserName

public static void updateUserName(long userId,
                                  String userName)
                           throws SystemException

Throws:

SystemException

getService

public static MBMessageLocalService getService()

setService

public void setService(MBMessageLocalService service)