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

java.lang.Object
  com.liferay.portlet.journal.service.http.JournalTemplateServiceJSON

public class JournalTemplateServiceJSON
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.JournalTemplateServiceUtil 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 com.liferay.portal.kernel.json.JSONArray. If the method in the service utility returns a com.liferay.portlet.journal.model.JournalTemplate, that is translated to a com.liferay.portal.kernel.json.JSONObject. Methods that JSON cannot safely use are skipped. The logic for the translation is encapsulated in com.liferay.portlet.journal.service.http.JournalTemplateJSONSerializer.

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:

JournalTemplateServiceUtil, JournalTemplateJSONSerializer

Constructor Summary

JournalTemplateServiceJSON()

Method Summary

static com.liferay.portal.kernel.json.JSONObject	copyTemplate(long groupId, java.lang.String oldTemplateId, java.lang.String newTemplateId, boolean autoTemplateId)
static void	deleteTemplate(long groupId, java.lang.String templateId)
static com.liferay.portal.kernel.json.JSONArray	getStructureTemplates(long groupId, java.lang.String structureId)
static com.liferay.portal.kernel.json.JSONObject	getTemplate(long groupId, java.lang.String templateId)

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalTemplateServiceJSON

public JournalTemplateServiceJSON()

Method Detail

copyTemplate

public static com.liferay.portal.kernel.json.JSONObject copyTemplate(long groupId,
                                                                     java.lang.String oldTemplateId,
                                                                     java.lang.String newTemplateId,
                                                                     boolean autoTemplateId)
                                                              throws com.liferay.portal.PortalException,
                                                                     com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

deleteTemplate

public static void deleteTemplate(long groupId,
                                  java.lang.String templateId)
                           throws com.liferay.portal.PortalException,
                                  com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getStructureTemplates

public static com.liferay.portal.kernel.json.JSONArray getStructureTemplates(long groupId,
                                                                             java.lang.String structureId)
                                                                      throws com.liferay.portal.PortalException,
                                                                             com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getTemplate

public static com.liferay.portal.kernel.json.JSONObject getTemplate(long groupId,
                                                                    java.lang.String templateId)
                                                             throws com.liferay.portal.PortalException,
                                                                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException