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

java.lang.Object
  extended by com.liferay.portlet.journal.service.http.JournalStructureServiceJSON

public class JournalStructureServiceJSON
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.JournalStructureServiceUtil 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.JournalStructure, 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.JournalStructureJSONSerializer.

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:
JournalStructureServiceUtil, JournalStructureJSONSerializer

Constructor Summary
JournalStructureServiceJSON()
           
 
Method Summary
static org.json.JSONObject addStructure(java.lang.String structureId, boolean autoStructureId, long plid, java.lang.String name, java.lang.String description, java.lang.String xsd, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addStructure(java.lang.String structureId, boolean autoStructureId, long plid, java.lang.String name, java.lang.String description, java.lang.String xsd, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteStructure(long groupId, java.lang.String structureId)
           
static org.json.JSONObject getStructure(long groupId, java.lang.String structureId)
           
static org.json.JSONObject updateStructure(long groupId, java.lang.String structureId, java.lang.String name, java.lang.String description, java.lang.String xsd)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JournalStructureServiceJSON

public JournalStructureServiceJSON()
Method Detail

addStructure

public static org.json.JSONObject addStructure(java.lang.String structureId,
                                               boolean autoStructureId,
                                               long plid,
                                               java.lang.String name,
                                               java.lang.String description,
                                               java.lang.String xsd,
                                               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

addStructure

public static org.json.JSONObject addStructure(java.lang.String structureId,
                                               boolean autoStructureId,
                                               long plid,
                                               java.lang.String name,
                                               java.lang.String description,
                                               java.lang.String xsd,
                                               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

deleteStructure

public static void deleteStructure(long groupId,
                                   java.lang.String structureId)
                            throws java.rmi.RemoteException,
                                   com.liferay.portal.SystemException,
                                   com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getStructure

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

updateStructure

public static org.json.JSONObject updateStructure(long groupId,
                                                  java.lang.String structureId,
                                                  java.lang.String name,
                                                  java.lang.String description,
                                                  java.lang.String xsd)
                                           throws java.rmi.RemoteException,
                                                  com.liferay.portal.SystemException,
                                                  com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException