com.liferay.message.boards.kernel.service

Class MBMessageServiceUtil

Object

com.liferay.message.boards.kernel.service.MBMessageServiceUtil

@ProviderType
public class MBMessageServiceUtil
extends Object

Provides the remote service utility for MBMessage. This utility wraps MBMessageServiceImpl and is the primary access point for service operations in application layer code running on a remote server. 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:

MBMessageService, MBMessageServiceBaseImpl, MBMessageServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
MBMessageServiceUtil()

Method Summary

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

Methods inherited from class Object

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

Constructor Detail

MBMessageServiceUtil

public MBMessageServiceUtil()

Method Detail

addDiscussionMessage

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

Throws:

PortalException

addMessage

public static 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

public static 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

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

Throws:

PortalException

addMessage

public static 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

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

Throws:

PortalException

deleteDiscussionMessage

public static void deleteDiscussionMessage(long messageId)
                                    throws PortalException

Throws:

PortalException

deleteDiscussionMessage

@Deprecated
public static 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

public static void deleteMessage(long messageId)
                          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

emptyMessageAttachments

public static void emptyMessageAttachments(long messageId)
                                    throws PortalException

Throws:

PortalException

getCategoryMessages

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

Throws:

PortalException

getCategoryMessagesCount

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

getCategoryMessagesRSS

public static 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

public static 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

public static int getGroupMessagesCount(long groupId,
                                        int status)

getGroupMessagesRSS

public static 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

public static 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

public static MBMessage getMessage(long messageId)
                            throws PortalException

Throws:

PortalException

getMessageDisplay

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

Throws:

PortalException

getMessageDisplay

@Deprecated
public static 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

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getThreadAnswersCount

public static int getThreadAnswersCount(long groupId,
                                        long categoryId,
                                        long threadId)

getThreadMessages

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

getThreadMessagesCount

public static int getThreadMessagesCount(long groupId,
                                         long categoryId,
                                         long threadId,
                                         int status)

getThreadMessagesRSS

public static 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

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

Throws:

PortalException

subscribeMessage

public static void subscribeMessage(long messageId)
                             throws PortalException

Throws:

PortalException

unsubscribeMessage

public static void unsubscribeMessage(long messageId)
                               throws PortalException

Throws:

PortalException

updateAnswer

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

Throws:

PortalException

updateDiscussionMessage

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

Throws:

PortalException

updateMessage

public static 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

getService

public static MBMessageService getService()