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

java.lang.Object
  extended bycom.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 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 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 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 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.JSONObject getMessage(long messageId)
           
static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(long messageId)
           
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, long categoryId, java.lang.String subject, java.lang.String body, java.util.List files, 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 files,
                                             boolean anonymous,
                                             double priority,
                                             java.lang.String[] tagsEntries,
                                             boolean addCommunityPermissions,
                                             boolean addGuestPermissions)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addMessage

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

addMessage

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

addMessage

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

deleteDiscussionMessage

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

deleteMessage

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

getMessage

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

getMessageDisplay

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

subscribeMessage

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

unsubscribeMessage

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

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 com.liferay.portal.SystemException,
                                                          com.liferay.portal.PortalException,
                                                          java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateMessage

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