com.liferay.portlet.bookmarks.service.http
Class BookmarksFolderServiceJSON

java.lang.Object
  extended bycom.liferay.portlet.bookmarks.service.http.BookmarksFolderServiceJSON

public class BookmarksFolderServiceJSON
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.bookmarks.service.BookmarksFolderServiceUtil 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.bookmarks.model.BookmarksFolder, 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.bookmarks.service.http.BookmarksFolderJSONSerializer.

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:
BookmarksFolderServiceUtil, BookmarksFolderJSONSerializer

Constructor Summary
BookmarksFolderServiceJSON()
           
 
Method Summary
static org.json.JSONObject addFolder(long plid, long parentFolderId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addFolder(long plid, long parentFolderId, java.lang.String name, java.lang.String description, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteFolder(long folderId)
           
static org.json.JSONObject getFolder(long folderId)
           
static org.json.JSONObject updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BookmarksFolderServiceJSON

public BookmarksFolderServiceJSON()
Method Detail

addFolder

public static org.json.JSONObject addFolder(long plid,
                                            long parentFolderId,
                                            java.lang.String name,
                                            java.lang.String description,
                                            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

addFolder

public static org.json.JSONObject addFolder(long plid,
                                            long parentFolderId,
                                            java.lang.String name,
                                            java.lang.String description,
                                            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

deleteFolder

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

getFolder

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

updateFolder

public static org.json.JSONObject updateFolder(long folderId,
                                               long parentFolderId,
                                               java.lang.String name,
                                               java.lang.String description,
                                               boolean mergeWithParentFolder)
                                        throws com.liferay.portal.SystemException,
                                               com.liferay.portal.PortalException,
                                               java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException