com.liferay.message.boards.kernel.service

Interface MBMessageService

All Superinterfaces:

BaseService

All Known Implementing Classes:

MBMessageServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MBMessageService
extends BaseService

Provides the remote service interface for MBMessage. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

MBMessageServiceUtil, MBMessageServiceBaseImpl, MBMessageServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
MBMessage	addDiscussionMessage(long groupId, String className, long classPK, long threadId, long parentMessageId, String subject, String body, ServiceContext serviceContext)
MBMessage	addMessage(long groupId, long categoryId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
MBMessage	addMessage(long groupId, long categoryId, String subject, String body, String format, String fileName, File file, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
MBMessage	addMessage(long categoryId, String subject, String body, ServiceContext serviceContext)
MBMessage	addMessage(long parentMessageId, String subject, String body, String format, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, boolean anonymous, double priority, boolean allowPingbacks, ServiceContext serviceContext)
void	addMessageAttachment(long messageId, String fileName, File file, String mimeType)
void	deleteDiscussionMessage(long messageId)
void	deleteDiscussionMessage(long groupId, String className, long classPK, String permissionClassName, long permissionClassPK, long permissionOwnerId, long messageId) Deprecated. As of 7.0.0, replaced by deleteDiscussionMessage(long)
void	deleteMessage(long messageId)
void	deleteMessageAttachment(long messageId, String fileName)
void	deleteMessageAttachments(long messageId)
void	emptyMessageAttachments(long messageId)
List<MBMessage>	getCategoryMessages(long groupId, long categoryId, int status, int start, int end)
int	getCategoryMessagesCount(long groupId, long categoryId, int status)
String	getCategoryMessagesRSS(long groupId, long categoryId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
String	getCompanyMessagesRSS(long companyId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
int	getGroupMessagesCount(long groupId, int status)
String	getGroupMessagesRSS(long groupId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
String	getGroupMessagesRSS(long groupId, long userId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
MBMessage	getMessage(long messageId)
MBMessageDisplay	getMessageDisplay(long messageId, int status)
MBMessageDisplay	getMessageDisplay(long messageId, int status, String threadView, boolean includePrevAndNext) Deprecated. As of 7.0.0, replaced by getMessageDisplay(long, int)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
int	getThreadAnswersCount(long groupId, long categoryId, long threadId)
List<MBMessage>	getThreadMessages(long groupId, long categoryId, long threadId, int status, int start, int end)
int	getThreadMessagesCount(long groupId, long categoryId, long threadId, int status)
String	getThreadMessagesRSS(long threadId, int status, int max, String type, double version, String displayStyle, String feedURL, String entryURL, ThemeDisplay themeDisplay)
void	restoreMessageAttachmentFromTrash(long messageId, String fileName)
void	subscribeMessage(long messageId)
void	unsubscribeMessage(long messageId)
void	updateAnswer(long messageId, boolean answer, boolean cascade)
MBMessage	updateDiscussionMessage(String className, long classPK, long messageId, String subject, String body, ServiceContext serviceContext)
MBMessage	updateMessage(long messageId, String subject, String body, List<ObjectValuePair<String,InputStream>> inputStreamOVPs, List<String> existingFiles, double priority, boolean allowPingbacks, ServiceContext serviceContext)

Method Detail

addDiscussionMessage

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

Throws:

PortalException

addMessage

MBMessage addMessage(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

MBMessage addMessage(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

MBMessage addMessage(long categoryId,
                     String subject,
                     String body,
                     ServiceContext serviceContext)
              throws PortalException

Throws:

PortalException

addMessage

MBMessage addMessage(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

addMessageAttachment

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

Throws:

PortalException

deleteDiscussionMessage

void deleteDiscussionMessage(long messageId)
                      throws PortalException

Throws:

PortalException

deleteDiscussionMessage

@Deprecated
void deleteDiscussionMessage(long groupId,
                                         String className,
                                         long classPK,
                                         String permissionClassName,
                                         long permissionClassPK,
                                         long permissionOwnerId,
                                         long messageId)
                                  throws PortalException

Deprecated. As of 7.0.0, replaced by deleteDiscussionMessage(long)

Throws:

PortalException

deleteMessage

void deleteMessage(long messageId)
            throws PortalException

Throws:

PortalException

deleteMessageAttachment

void deleteMessageAttachment(long messageId,
                             String fileName)
                      throws PortalException

Throws:

PortalException

deleteMessageAttachments

void deleteMessageAttachments(long messageId)
                       throws PortalException

Throws:

PortalException

emptyMessageAttachments

void emptyMessageAttachments(long messageId)
                      throws PortalException

Throws:

PortalException

getCategoryMessages

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

Throws:

PortalException

getCategoryMessagesCount

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

getCategoryMessagesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getCategoryMessagesRSS(long groupId,
                                                                                                 long categoryId,
                                                                                                 int status,
                                                                                                 int max,
                                                                                                 String type,
                                                                                                 double version,
                                                                                                 String displayStyle,
                                                                                                 String feedURL,
                                                                                                 String entryURL,
                                                                                                 ThemeDisplay themeDisplay)
                                                                                          throws PortalException

Throws:

PortalException

getCompanyMessagesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getCompanyMessagesRSS(long companyId,
                                                                                                int status,
                                                                                                int max,
                                                                                                String type,
                                                                                                double version,
                                                                                                String displayStyle,
                                                                                                String feedURL,
                                                                                                String entryURL,
                                                                                                ThemeDisplay themeDisplay)
                                                                                         throws PortalException

Throws:

PortalException

getGroupMessagesCount

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

getGroupMessagesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getGroupMessagesRSS(long groupId,
                                                                                              int status,
                                                                                              int max,
                                                                                              String type,
                                                                                              double version,
                                                                                              String displayStyle,
                                                                                              String feedURL,
                                                                                              String entryURL,
                                                                                              ThemeDisplay themeDisplay)
                                                                                       throws PortalException

Throws:

PortalException

getGroupMessagesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getGroupMessagesRSS(long groupId,
                                                                                              long userId,
                                                                                              int status,
                                                                                              int max,
                                                                                              String type,
                                                                                              double version,
                                                                                              String displayStyle,
                                                                                              String feedURL,
                                                                                              String entryURL,
                                                                                              ThemeDisplay themeDisplay)
                                                                                       throws PortalException

Throws:

PortalException

getMessage

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

Throws:

PortalException

getMessageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMessageDisplay getMessageDisplay(long messageId,
                                                                                                      int status)
                                                                                               throws PortalException

Throws:

PortalException

getMessageDisplay

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

Deprecated. As of 7.0.0, replaced by getMessageDisplay(long, int)

Throws:

PortalException

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getThreadAnswersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getThreadAnswersCount(long groupId,
                                                                                             long categoryId,
                                                                                             long threadId)

getThreadMessages

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

getThreadMessagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getThreadMessagesCount(long groupId,
                                                                                              long categoryId,
                                                                                              long threadId,
                                                                                              int status)

getThreadMessagesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getThreadMessagesRSS(long threadId,
                                                                                               int status,
                                                                                               int max,
                                                                                               String type,
                                                                                               double version,
                                                                                               String displayStyle,
                                                                                               String feedURL,
                                                                                               String entryURL,
                                                                                               ThemeDisplay themeDisplay)
                                                                                        throws PortalException

Throws:

PortalException

restoreMessageAttachmentFromTrash

void restoreMessageAttachmentFromTrash(long messageId,
                                       String fileName)
                                throws PortalException

Throws:

PortalException

subscribeMessage

void subscribeMessage(long messageId)
               throws PortalException

Throws:

PortalException

unsubscribeMessage

void unsubscribeMessage(long messageId)
                 throws PortalException

Throws:

PortalException

updateAnswer

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

Throws:

PortalException

updateDiscussionMessage

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

Throws:

PortalException

updateMessage

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

Throws:

PortalException