com.liferay.portlet.messageboards.service
Interface MBMessageLocalService

All Known Implementing Classes:

MBMessageLocalServiceBaseImpl, MBMessageLocalServiceImpl, MBMessageLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MBMessageLocalService

The interface for the message-boards message local service.

Never modify or reference this interface directly. Always use MBMessageLocalServiceUtil to access the message-boards message local service. Add custom service methods to MBMessageLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:

MBMessageLocalServiceUtil, MBMessageLocalServiceBaseImpl, MBMessageLocalServiceImpl

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

Method Summary

MBMessage	addDiscussionMessage(long userId, String userName, long groupId, String className, long classPK, int workflowAction)
MBMessage	addDiscussionMessage(long userId, String userName, long groupId, String className, long classPK, long threadId, long parentMessageId, String subject, String body, ServiceContext serviceContext)
MBMessage	addMBMessage(MBMessage mbMessage) Adds the message-boards message to the database.
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)
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)
void	addMessageResources(long messageId, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addMessageResources(long messageId, String[] communityPermissions, String[] guestPermissions)
void	addMessageResources(MBMessage message, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addMessageResources(MBMessage message, String[] communityPermissions, String[] guestPermissions)
MBMessage	createMBMessage(long messageId) Creates a new message-boards message with the primary key.
void	deleteDiscussionMessage(long messageId)
void	deleteDiscussionMessages(String className, long classPK)
void	deleteMBMessage(long messageId) Deletes the message-boards message with the primary key from the database.
void	deleteMBMessage(MBMessage mbMessage) Deletes the message-boards message from the database.
void	deleteMessage(long messageId)
void	deleteMessage(MBMessage message)
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<MBMessage>	getCategoryMessages(long groupId, long categoryId, int status, int start, int end)
List<MBMessage>	getCategoryMessages(long groupId, long categoryId, int status, int start, int end, OrderByComparator obc)
int	getCategoryMessagesCount(long groupId, long categoryId, int status)
List<MBMessage>	getCompanyMessages(long companyId, int status, int start, int end)
List<MBMessage>	getCompanyMessages(long companyId, int status, int start, int end, OrderByComparator obc)
int	getCompanyMessagesCount(long companyId, int status)
MBMessageDisplay	getDiscussionMessageDisplay(long userId, long groupId, String className, long classPK, int status)
MBMessageDisplay	getDiscussionMessageDisplay(long userId, long groupId, String className, long classPK, int status, String threadView)
int	getDiscussionMessagesCount(long classNameId, long classPK, int status)
int	getDiscussionMessagesCount(String className, long classPK, int status)
List<MBDiscussion>	getDiscussions(String className)
List<MBMessage>	getGroupMessages(long groupId, int status, int start, int end)
List<MBMessage>	getGroupMessages(long groupId, int status, int start, int end, OrderByComparator obc)
List<MBMessage>	getGroupMessages(long groupId, long userId, int status, int start, int end)
List<MBMessage>	getGroupMessages(long groupId, long userId, int status, int start, int end, OrderByComparator obc)
int	getGroupMessagesCount(long groupId, int status)
int	getGroupMessagesCount(long groupId, long userId, int status)
MBMessage	getMBMessage(long messageId) Gets the message-boards message with the primary key.
MBMessage	getMBMessageByUuidAndGroupId(String uuid, long groupId) Gets the message-boards message with the UUID and group id.
List<MBMessage>	getMBMessages(int start, int end) Gets a range of all the message-boards messages.
int	getMBMessagesCount() Gets the number of message-boards messages.
MBMessage	getMessage(long messageId)
MBMessageDisplay	getMessageDisplay(long messageId, int status, String threadView, boolean includePrevAndNext)
MBMessageDisplay	getMessageDisplay(MBMessage message, int status, String threadView, boolean includePrevAndNext)
List<MBMessage>	getMessages(String className, long classPK, int status)
List<MBMessage>	getNoAssetMessages()
int	getPositionInThread(long messageId)
List<MBMessage>	getThreadMessages(long threadId, int status)
List<MBMessage>	getThreadMessages(long threadId, int status, Comparator<MBMessage> comparator)
List<MBMessage>	getThreadMessages(long threadId, int status, int start, int end)
int	getThreadMessagesCount(long threadId, int status)
List<MBMessage>	getThreadRepliesMessages(long threadId, int status, int start, int end)
void	subscribeMessage(long userId, long messageId)
void	unsubscribeMessage(long userId, long messageId)
void	updateAsset(long userId, MBMessage message, long[] assetCategoryIds, String[] assetTagNames)
MBMessage	updateDiscussionMessage(long userId, long messageId, String subject, String body, int workflowAction)
MBMessage	updateMBMessage(MBMessage mbMessage) Updates the message-boards message in the database.
MBMessage	updateMBMessage(MBMessage mbMessage, boolean merge) Updates the message-boards message in the database.
MBMessage	updateMessage(long userId, long messageId, String subject, String body, List<ObjectValuePair<String,byte[]>> files, List<String> existingFiles, double priority, boolean allowPingbacks, ServiceContext serviceContext)
MBMessage	updateMessage(long messageId, String body)
MBMessage	updateStatus(long userId, long messageId, int status, ServiceContext serviceContext)
void	updateUserName(long userId, String userName)

Method Detail

addMBMessage

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

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

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

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

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

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

Throws:

PortalException

SystemException

addDiscussionMessage

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

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

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

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

Throws:

PortalException

SystemException

addMessageResources

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

Throws:

PortalException

SystemException

addMessageResources

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

Throws:

PortalException

SystemException

addMessageResources

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

Throws:

PortalException

SystemException

deleteDiscussionMessage

void deleteDiscussionMessage(long messageId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

deleteDiscussionMessages

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

Throws:

PortalException

SystemException

deleteMessage

void deleteMessage(long messageId)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

deleteMessage

void deleteMessage(MBMessage message)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getCategoryMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getCategoryMessages(long groupId,
                                                                             long categoryId,
                                                                             int status,
                                                                             int start,
                                                                             int end)
                                    throws SystemException

Throws:

SystemException

getCategoryMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getCategoryMessages(long groupId,
                                                                             long categoryId,
                                                                             int status,
                                                                             int start,
                                                                             int end,
                                                                             OrderByComparator obc)
                                    throws SystemException

Throws:

SystemException

getCategoryMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoryMessagesCount(long groupId,
                                                                      long categoryId,
                                                                      int status)
                             throws SystemException

Throws:

SystemException

getCompanyMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getCompanyMessages(long companyId,
                                                                            int status,
                                                                            int start,
                                                                            int end)
                                   throws SystemException

Throws:

SystemException

getCompanyMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getCompanyMessages(long companyId,
                                                                            int status,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator obc)
                                   throws SystemException

Throws:

SystemException

getCompanyMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyMessagesCount(long companyId,
                                                                     int status)
                            throws SystemException

Throws:

SystemException

getDiscussionMessageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMessageDisplay getDiscussionMessageDisplay(long userId,
                                                                                      long groupId,
                                                                                      String className,
                                                                                      long classPK,
                                                                                      int status)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

getDiscussionMessageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMessageDisplay getDiscussionMessageDisplay(long userId,
                                                                                      long groupId,
                                                                                      String className,
                                                                                      long classPK,
                                                                                      int status,
                                                                                      String threadView)
                                             throws PortalException,
                                                    SystemException

Throws:

PortalException

SystemException

getDiscussionMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDiscussionMessagesCount(long classNameId,
                                                                        long classPK,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getDiscussionMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getDiscussionMessagesCount(String className,
                                                                        long classPK,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getDiscussions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBDiscussion> getDiscussions(String className)
                                  throws SystemException

Throws:

SystemException

getGroupMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getGroupMessages(long groupId,
                                                                          int status,
                                                                          int start,
                                                                          int end)
                                 throws SystemException

Throws:

SystemException

getGroupMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getGroupMessages(long groupId,
                                                                          int status,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws SystemException

Throws:

SystemException

getGroupMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getGroupMessages(long groupId,
                                                                          long userId,
                                                                          int status,
                                                                          int start,
                                                                          int end)
                                 throws SystemException

Throws:

SystemException

getGroupMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getGroupMessages(long groupId,
                                                                          long userId,
                                                                          int status,
                                                                          int start,
                                                                          int end,
                                                                          OrderByComparator obc)
                                 throws SystemException

Throws:

SystemException

getGroupMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupMessagesCount(long groupId,
                                                                   int status)
                          throws SystemException

Throws:

SystemException

getGroupMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupMessagesCount(long groupId,
                                                                   long userId,
                                                                   int status)
                          throws SystemException

Throws:

SystemException

getMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMessage getMessage(long messageId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getMessageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMessageDisplay getMessageDisplay(long messageId,
                                                                            int status,
                                                                            String threadView,
                                                                            boolean includePrevAndNext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getMessageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMessageDisplay getMessageDisplay(MBMessage message,
                                                                            int status,
                                                                            String threadView,
                                                                            boolean includePrevAndNext)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getMessages(String className,
                                                                     long classPK,
                                                                     int status)
                            throws SystemException

Throws:

SystemException

getNoAssetMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getNoAssetMessages()
                                   throws SystemException

Throws:

SystemException

getPositionInThread

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPositionInThread(long messageId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getThreadMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getThreadMessages(long threadId,
                                                                           int status)
                                  throws SystemException

Throws:

SystemException

getThreadMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getThreadMessages(long threadId,
                                                                           int status,
                                                                           Comparator<MBMessage> comparator)
                                  throws SystemException

Throws:

SystemException

getThreadMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getThreadMessages(long threadId,
                                                                           int status,
                                                                           int start,
                                                                           int end)
                                  throws SystemException

Throws:

SystemException

getThreadMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getThreadMessagesCount(long threadId,
                                                                    int status)
                           throws SystemException

Throws:

SystemException

getThreadRepliesMessages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMessage> getThreadRepliesMessages(long threadId,
                                                                                  int status,
                                                                                  int start,
                                                                                  int end)
                                         throws SystemException

Throws:

SystemException

subscribeMessage

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

Throws:

PortalException

SystemException

unsubscribeMessage

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateDiscussionMessage

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

Throws:

PortalException

SystemException

updateMessage

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

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

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException

updateUserName

void updateUserName(long userId,
                    String userName)
                    throws SystemException

Throws:

SystemException