com.liferay.portlet.messageboards.service.http
Class MBMessageServiceJSON

java.lang.Object
  extended by com.liferay.portlet.messageboards.service.http.MBMessageServiceJSON

public class MBMessageServiceJSON
extends java.lang.Object

View Source

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

This class provides a JSON utility for the com.liferay.portlet.messageboards.service.MBMessageServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it is difficult for JSON to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to a org.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.messageboards.model.MBMessage, that is translated to a org.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.messageboards.service.http.MBMessageJSONSerializer.

This allows you to call the the backend services directly from JavaScript. See portal-web/docroot/html/portlet/tags_admin/unpacked.js for a reference of how that portlet uses the generated JavaScript in portal-web/docroot/html/js/service.js to call the backend services directly from JavaScript.

The JSON utility is only generated for remote services.

Author:
Brian Wing Shun Chan
See Also:
MBMessageServiceUtil, MBMessageJSONSerializer

Constructor Summary
MBMessageServiceJSON()
           
 
Method Summary
static org.json.JSONObject addMessage(long categoryId, long threadId, long parentMessageId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, boolean anonymous, double priority, java.lang.String[] tagsEntries, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addMessage(long categoryId, long threadId, long parentMessageId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, boolean anonymous, double priority, java.lang.String[] tagsEntries, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static org.json.JSONObject addMessage(long categoryId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, boolean anonymous, double priority, java.lang.String[] tagsEntries, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addMessage(long categoryId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, boolean anonymous, double priority, java.lang.String[] tagsEntries, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteDiscussionMessage(long groupId, java.lang.String className, long classPK, long messageId)
           
static void deleteMessage(long messageId)
           
static org.json.JSONArray getCategoryMessages(long categoryId, int begin, int end)
           
static int getCategoryMessagesCount(long categoryId)
           
static java.lang.String getCategoryMessagesRSS(long categoryId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static java.lang.String getCompanyMessagesRSS(long companyId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static java.lang.String getGroupMessagesRSS(long groupId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static java.lang.String getGroupMessagesRSS(long groupId, long userId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static org.json.JSONObject getMessage(long messageId)
           
static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(long messageId)
           
static java.lang.String getThreadMessagesRSS(long threadId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL)
           
static void subscribeMessage(long messageId)
           
static void unsubscribeMessage(long messageId)
           
static org.json.JSONObject updateDiscussionMessage(long groupId, java.lang.String className, long classPK, long messageId, java.lang.String subject, java.lang.String body)
           
static org.json.JSONObject updateMessage(long messageId, java.lang.String subject, java.lang.String body, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files, java.util.List<java.lang.String> existingFiles, double priority, java.lang.String[] tagsEntries)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBMessageServiceJSON

public MBMessageServiceJSON()
Method Detail

addMessage

public static org.json.JSONObject addMessage(long categoryId,
                                             java.lang.String subject,
                                             java.lang.String body,
                                             java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                             boolean anonymous,
                                             double priority,
                                             java.lang.String[] tagsEntries,
                                             boolean addCommunityPermissions,
                                             boolean addGuestPermissions)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addMessage

public static org.json.JSONObject addMessage(long categoryId,
                                             java.lang.String subject,
                                             java.lang.String body,
                                             java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                             boolean anonymous,
                                             double priority,
                                             java.lang.String[] tagsEntries,
                                             java.lang.String[] communityPermissions,
                                             java.lang.String[] guestPermissions)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addMessage

public static org.json.JSONObject addMessage(long categoryId,
                                             long threadId,
                                             long parentMessageId,
                                             java.lang.String subject,
                                             java.lang.String body,
                                             java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                             boolean anonymous,
                                             double priority,
                                             java.lang.String[] tagsEntries,
                                             boolean addCommunityPermissions,
                                             boolean addGuestPermissions)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addMessage

public static org.json.JSONObject addMessage(long categoryId,
                                             long threadId,
                                             long parentMessageId,
                                             java.lang.String subject,
                                             java.lang.String body,
                                             java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                             boolean anonymous,
                                             double priority,
                                             java.lang.String[] tagsEntries,
                                             java.lang.String[] communityPermissions,
                                             java.lang.String[] guestPermissions)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteDiscussionMessage

public static void deleteDiscussionMessage(long groupId,
                                           java.lang.String className,
                                           long classPK,
                                           long messageId)
                                    throws java.rmi.RemoteException,
                                           com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteMessage

public static void deleteMessage(long messageId)
                          throws java.rmi.RemoteException,
                                 com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getCategoryMessages

public static org.json.JSONArray getCategoryMessages(long categoryId,
                                                     int begin,
                                                     int end)
                                              throws java.rmi.RemoteException,
                                                     com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getCategoryMessagesCount

public static int getCategoryMessagesCount(long categoryId)
                                    throws java.rmi.RemoteException,
                                           com.liferay.portal.SystemException,
                                           com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getCategoryMessagesRSS

public static java.lang.String getCategoryMessagesRSS(long categoryId,
                                                      int max,
                                                      java.lang.String type,
                                                      double version,
                                                      java.lang.String displayStyle,
                                                      java.lang.String feedURL,
                                                      java.lang.String entryURL)
                                               throws java.rmi.RemoteException,
                                                      com.liferay.portal.SystemException,
                                                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getCompanyMessagesRSS

public static java.lang.String getCompanyMessagesRSS(long companyId,
                                                     int max,
                                                     java.lang.String type,
                                                     double version,
                                                     java.lang.String displayStyle,
                                                     java.lang.String feedURL,
                                                     java.lang.String entryURL)
                                              throws java.rmi.RemoteException,
                                                     com.liferay.portal.SystemException,
                                                     com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getGroupMessagesRSS

public static java.lang.String getGroupMessagesRSS(long groupId,
                                                   int max,
                                                   java.lang.String type,
                                                   double version,
                                                   java.lang.String displayStyle,
                                                   java.lang.String feedURL,
                                                   java.lang.String entryURL)
                                            throws java.rmi.RemoteException,
                                                   com.liferay.portal.SystemException,
                                                   com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getGroupMessagesRSS

public static java.lang.String getGroupMessagesRSS(long groupId,
                                                   long userId,
                                                   int max,
                                                   java.lang.String type,
                                                   double version,
                                                   java.lang.String displayStyle,
                                                   java.lang.String feedURL,
                                                   java.lang.String entryURL)
                                            throws java.rmi.RemoteException,
                                                   com.liferay.portal.SystemException,
                                                   com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getMessage

public static org.json.JSONObject getMessage(long messageId)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getMessageDisplay

public static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(long messageId)
                                                                                  throws java.rmi.RemoteException,
                                                                                         com.liferay.portal.SystemException,
                                                                                         com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getThreadMessagesRSS

public static java.lang.String getThreadMessagesRSS(long threadId,
                                                    int max,
                                                    java.lang.String type,
                                                    double version,
                                                    java.lang.String displayStyle,
                                                    java.lang.String feedURL,
                                                    java.lang.String entryURL)
                                             throws java.rmi.RemoteException,
                                                    com.liferay.portal.SystemException,
                                                    com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

subscribeMessage

public static void subscribeMessage(long messageId)
                             throws java.rmi.RemoteException,
                                    com.liferay.portal.SystemException,
                                    com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsubscribeMessage

public static void unsubscribeMessage(long messageId)
                               throws java.rmi.RemoteException,
                                      com.liferay.portal.SystemException,
                                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateDiscussionMessage

public static org.json.JSONObject updateDiscussionMessage(long groupId,
                                                          java.lang.String className,
                                                          long classPK,
                                                          long messageId,
                                                          java.lang.String subject,
                                                          java.lang.String body)
                                                   throws java.rmi.RemoteException,
                                                          com.liferay.portal.SystemException,
                                                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateMessage

public static org.json.JSONObject updateMessage(long messageId,
                                                java.lang.String subject,
                                                java.lang.String body,
                                                java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,byte[]>> files,
                                                java.util.List<java.lang.String> existingFiles,
                                                double priority,
                                                java.lang.String[] tagsEntries)
                                         throws java.rmi.RemoteException,
                                                com.liferay.portal.SystemException,
                                                com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException