com.liferay.portlet.journal.service.http
Class JournalArticleServiceJSON

java.lang.Object
  extended bycom.liferay.portlet.journal.service.http.JournalArticleServiceJSON

public class JournalArticleServiceJSON
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.journal.service.JournalArticleServiceUtil 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.journal.model.JournalArticle, 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.journal.service.http.JournalArticleJSONSerializer.

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:
JournalArticleServiceUtil, JournalArticleJSONSerializer

Constructor Summary
JournalArticleServiceJSON()
           
 
Method Summary
static org.json.JSONObject getArticle(long groupId, java.lang.String articleId, double version)
           
static void removeArticleLocale(long companyId, java.lang.String languageId)
           
static org.json.JSONObject removeArticleLocale(long groupId, java.lang.String articleId, double version, java.lang.String languageId)
           
static org.json.JSONObject updateContent(long groupId, java.lang.String articleId, double version, java.lang.String content)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalArticleServiceJSON

public JournalArticleServiceJSON()
Method Detail

getArticle

public static org.json.JSONObject getArticle(long groupId,
                                             java.lang.String articleId,
                                             double version)
                                      throws com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException,
                                             java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

removeArticleLocale

public static void removeArticleLocale(long companyId,
                                       java.lang.String languageId)
                                throws com.liferay.portal.SystemException,
                                       com.liferay.portal.PortalException,
                                       java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

removeArticleLocale

public static org.json.JSONObject removeArticleLocale(long groupId,
                                                      java.lang.String articleId,
                                                      double version,
                                                      java.lang.String languageId)
                                               throws com.liferay.portal.SystemException,
                                                      com.liferay.portal.PortalException,
                                                      java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateContent

public static org.json.JSONObject updateContent(long groupId,
                                                java.lang.String articleId,
                                                double version,
                                                java.lang.String content)
                                         throws com.liferay.portal.SystemException,
                                                com.liferay.portal.PortalException,
                                                java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException