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

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

public class BookmarksEntryServiceJSON
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.BookmarksEntryServiceUtil 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.BookmarksEntry, 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.BookmarksEntryJSONSerializer.

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:
BookmarksEntryServiceUtil, BookmarksEntryJSONSerializer

Constructor Summary
BookmarksEntryServiceJSON()
           
 
Method Summary
static org.json.JSONObject addEntry(long folderId, java.lang.String name, java.lang.String url, java.lang.String comments, java.lang.String[] tagsEntries, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static org.json.JSONObject addEntry(long folderId, java.lang.String name, java.lang.String url, java.lang.String comments, java.lang.String[] tagsEntries, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static void deleteEntry(long entryId)
           
static org.json.JSONObject getEntry(long entryId)
           
static org.json.JSONObject openEntry(long entryId)
           
static org.json.JSONObject updateEntry(long entryId, long folderId, java.lang.String name, java.lang.String url, java.lang.String comments, java.lang.String[] tagsEntries)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BookmarksEntryServiceJSON

public BookmarksEntryServiceJSON()
Method Detail

addEntry

public static org.json.JSONObject addEntry(long folderId,
                                           java.lang.String name,
                                           java.lang.String url,
                                           java.lang.String comments,
                                           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

addEntry

public static org.json.JSONObject addEntry(long folderId,
                                           java.lang.String name,
                                           java.lang.String url,
                                           java.lang.String comments,
                                           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

deleteEntry

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

getEntry

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

openEntry

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

updateEntry

public static org.json.JSONObject updateEntry(long entryId,
                                              long folderId,
                                              java.lang.String name,
                                              java.lang.String url,
                                              java.lang.String comments,
                                              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