BookmarksEntryServiceJSON.java |
1 /** 2 * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved. 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a copy 5 * of this software and associated documentation files (the "Software"), to deal 6 * in the Software without restriction, including without limitation the rights 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 8 * copies of the Software, and to permit persons to whom the Software is 9 * furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice shall be included in 12 * all copies or substantial portions of the Software. 13 * 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 20 * SOFTWARE. 21 */ 22 23 package com.liferay.portlet.bookmarks.service.http; 24 25 import com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil; 26 27 import org.json.JSONObject; 28 29 /** 30 * <a href="BookmarksEntryServiceJSON.java.html"><b><i>View Source</i></b></a> 31 * 32 * <p> 33 * ServiceBuilder generated this class. Modifications in this class will be overwritten 34 * the next time is generated. 35 * </p> 36 * 37 * <p> 38 * This class provides a JSON utility for the <code>com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil</code> 39 * service utility. The static methods of this class calls the same methods of the 40 * service utility. However, the signatures are different because it is difficult 41 * for JSON to support certain types. 42 * </p> 43 * 44 * <p> 45 * ServiceBuilder follows certain rules in translating the methods. For example, 46 * if the method in the service utility returns a <code>java.util.List</code>, that 47 * is translated to a <code>org.json.JSONArray</code>. If the method in the service 48 * utility returns a <code>com.liferay.portlet.bookmarks.model.BookmarksEntry</code>, 49 * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON cannot 50 * safely use are skipped. The logic for the translation is encapsulated in <code>com.liferay.portlet.bookmarks.service.http.BookmarksEntryJSONSerializer</code>. 51 * </p> 52 * 53 * <p> 54 * This allows you to call the the backend services directly from JavaScript. See 55 * <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a reference 56 * of how that portlet uses the generated JavaScript in <code>portal-web/docroot/html/js/service.js</code> 57 * to call the backend services directly from JavaScript. 58 * </p> 59 * 60 * <p> 61 * The JSON utility is only generated for remote services. 62 * </p> 63 * 64 * @author Brian Wing Shun Chan 65 * 66 * @see com.liferay.portlet.bookmarks.service.BookmarksEntryServiceUtil 67 * @see com.liferay.portlet.bookmarks.service.http.BookmarksEntryJSONSerializer 68 * 69 */ 70 public class BookmarksEntryServiceJSON { 71 public static JSONObject addEntry(long folderId, java.lang.String name, 72 java.lang.String url, java.lang.String comments, 73 java.lang.String[] tagsEntries, boolean addCommunityPermissions, 74 boolean addGuestPermissions) 75 throws com.liferay.portal.SystemException, 76 com.liferay.portal.PortalException, java.rmi.RemoteException { 77 com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.addEntry(folderId, 78 name, url, comments, tagsEntries, addCommunityPermissions, 79 addGuestPermissions); 80 81 return BookmarksEntryJSONSerializer.toJSONObject(returnValue); 82 } 83 84 public static JSONObject addEntry(long folderId, java.lang.String name, 85 java.lang.String url, java.lang.String comments, 86 java.lang.String[] tagsEntries, 87 java.lang.String[] communityPermissions, 88 java.lang.String[] guestPermissions) 89 throws com.liferay.portal.SystemException, 90 com.liferay.portal.PortalException, java.rmi.RemoteException { 91 com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.addEntry(folderId, 92 name, url, comments, tagsEntries, communityPermissions, 93 guestPermissions); 94 95 return BookmarksEntryJSONSerializer.toJSONObject(returnValue); 96 } 97 98 public static void deleteEntry(long entryId) 99 throws com.liferay.portal.SystemException, 100 com.liferay.portal.PortalException, java.rmi.RemoteException { 101 BookmarksEntryServiceUtil.deleteEntry(entryId); 102 } 103 104 public static JSONObject getEntry(long entryId) 105 throws com.liferay.portal.SystemException, 106 com.liferay.portal.PortalException, java.rmi.RemoteException { 107 com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.getEntry(entryId); 108 109 return BookmarksEntryJSONSerializer.toJSONObject(returnValue); 110 } 111 112 public static JSONObject openEntry(long entryId) 113 throws com.liferay.portal.SystemException, 114 com.liferay.portal.PortalException, java.rmi.RemoteException { 115 com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.openEntry(entryId); 116 117 return BookmarksEntryJSONSerializer.toJSONObject(returnValue); 118 } 119 120 public static JSONObject updateEntry(long entryId, long folderId, 121 java.lang.String name, java.lang.String url, java.lang.String comments, 122 java.lang.String[] tagsEntries) 123 throws com.liferay.portal.SystemException, 124 com.liferay.portal.PortalException, java.rmi.RemoteException { 125 com.liferay.portlet.bookmarks.model.BookmarksEntry returnValue = BookmarksEntryServiceUtil.updateEntry(entryId, 126 folderId, name, url, comments, tagsEntries); 127 128 return BookmarksEntryJSONSerializer.toJSONObject(returnValue); 129 } 130 }