BookmarksFolderServiceJSON.java |
1 /** 2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved. 3 * 4 * The contents of this file are subject to the terms of the Liferay Enterprise 5 * Subscription License ("License"). You may not use this file except in 6 * compliance with the License. You can obtain a copy of the License by 7 * contacting Liferay, Inc. See the License for the specific language governing 8 * permissions and limitations under the License, including but not limited to 9 * distribution rights of the Software. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 12 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 13 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 14 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 15 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 17 * SOFTWARE. 18 */ 19 20 package com.liferay.portlet.bookmarks.service.http; 21 22 import com.liferay.portal.kernel.json.JSONObject; 23 24 import com.liferay.portlet.bookmarks.service.BookmarksFolderServiceUtil; 25 26 /** 27 * <a href="BookmarksFolderServiceJSON.java.html"><b><i>View Source</i></b></a> 28 * 29 * <p> 30 * ServiceBuilder generated this class. Modifications in this class will be 31 * overwritten the next time is generated. 32 * </p> 33 * 34 * <p> 35 * This class provides a JSON utility for the 36 * <code>com.liferay.portlet.bookmarks.service.BookmarksFolderServiceUtil</code> 37 * service utility. The static methods of this class calls the same methods of 38 * the service utility. However, the signatures are different because it is 39 * difficult for JSON to support certain types. 40 * </p> 41 * 42 * <p> 43 * ServiceBuilder follows certain rules in translating the methods. For example, 44 * if the method in the service utility returns a <code>java.util.List</code>, 45 * that is translated to a 46 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the 47 * service utility returns a <code>com.liferay.portlet.bookmarks.model.BookmarksFolder</code>, 48 * that is translated to a 49 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON 50 * cannot safely use are skipped. The logic for the translation is encapsulated 51 * in <code>com.liferay.portlet.bookmarks.service.http.BookmarksFolderJSONSerializer</code>. 52 * </p> 53 * 54 * <p> 55 * This allows you to call the the backend services directly from JavaScript. 56 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a 57 * reference of how that portlet uses the generated JavaScript in 58 * <code>portal-web/docroot/html/js/service.js</code> to call the backend 59 * services directly from JavaScript. 60 * </p> 61 * 62 * <p> 63 * The JSON utility is only generated for remote services. 64 * </p> 65 * 66 * @author Brian Wing Shun Chan 67 * 68 * @see com.liferay.portlet.bookmarks.service.BookmarksFolderServiceUtil 69 * @see com.liferay.portlet.bookmarks.service.http.BookmarksFolderJSONSerializer 70 * 71 */ 72 public class BookmarksFolderServiceJSON { 73 public static JSONObject addFolder(long plid, long parentFolderId, 74 java.lang.String name, java.lang.String description, 75 boolean addCommunityPermissions, boolean addGuestPermissions) 76 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 77 com.liferay.portal.SystemException { 78 com.liferay.portlet.bookmarks.model.BookmarksFolder returnValue = BookmarksFolderServiceUtil.addFolder(plid, 79 parentFolderId, name, description, addCommunityPermissions, 80 addGuestPermissions); 81 82 return BookmarksFolderJSONSerializer.toJSONObject(returnValue); 83 } 84 85 public static JSONObject addFolder(long plid, long parentFolderId, 86 java.lang.String name, java.lang.String description, 87 java.lang.String[] communityPermissions, 88 java.lang.String[] guestPermissions) 89 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 90 com.liferay.portal.SystemException { 91 com.liferay.portlet.bookmarks.model.BookmarksFolder returnValue = BookmarksFolderServiceUtil.addFolder(plid, 92 parentFolderId, name, description, communityPermissions, 93 guestPermissions); 94 95 return BookmarksFolderJSONSerializer.toJSONObject(returnValue); 96 } 97 98 public static void deleteFolder(long folderId) 99 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 100 com.liferay.portal.SystemException { 101 BookmarksFolderServiceUtil.deleteFolder(folderId); 102 } 103 104 public static JSONObject getFolder(long folderId) 105 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 106 com.liferay.portal.SystemException { 107 com.liferay.portlet.bookmarks.model.BookmarksFolder returnValue = BookmarksFolderServiceUtil.getFolder(folderId); 108 109 return BookmarksFolderJSONSerializer.toJSONObject(returnValue); 110 } 111 112 public static JSONObject updateFolder(long folderId, long parentFolderId, 113 java.lang.String name, java.lang.String description, 114 boolean mergeWithParentFolder) 115 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 116 com.liferay.portal.SystemException { 117 com.liferay.portlet.bookmarks.model.BookmarksFolder returnValue = BookmarksFolderServiceUtil.updateFolder(folderId, 118 parentFolderId, name, description, mergeWithParentFolder); 119 120 return BookmarksFolderJSONSerializer.toJSONObject(returnValue); 121 } 122 }