DLFileShortcutServiceJSON.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.documentlibrary.service.http; 21 22 import com.liferay.portal.kernel.json.JSONObject; 23 24 import com.liferay.portlet.documentlibrary.service.DLFileShortcutServiceUtil; 25 26 /** 27 * <a href="DLFileShortcutServiceJSON.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.documentlibrary.service.DLFileShortcutServiceUtil</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.documentlibrary.model.DLFileShortcut</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.documentlibrary.service.http.DLFileShortcutJSONSerializer</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.documentlibrary.service.DLFileShortcutServiceUtil 69 * @see com.liferay.portlet.documentlibrary.service.http.DLFileShortcutJSONSerializer 70 * 71 */ 72 public class DLFileShortcutServiceJSON { 73 public static JSONObject addFileShortcut(long folderId, long toFolderId, 74 java.lang.String toName, boolean addCommunityPermissions, 75 boolean addGuestPermissions) 76 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 77 com.liferay.portal.SystemException { 78 com.liferay.portlet.documentlibrary.model.DLFileShortcut returnValue = DLFileShortcutServiceUtil.addFileShortcut(folderId, 79 toFolderId, toName, addCommunityPermissions, addGuestPermissions); 80 81 return DLFileShortcutJSONSerializer.toJSONObject(returnValue); 82 } 83 84 public static JSONObject addFileShortcut(long folderId, long toFolderId, 85 java.lang.String toName, java.lang.String[] communityPermissions, 86 java.lang.String[] guestPermissions) 87 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 88 com.liferay.portal.SystemException { 89 com.liferay.portlet.documentlibrary.model.DLFileShortcut returnValue = DLFileShortcutServiceUtil.addFileShortcut(folderId, 90 toFolderId, toName, communityPermissions, guestPermissions); 91 92 return DLFileShortcutJSONSerializer.toJSONObject(returnValue); 93 } 94 95 public static void deleteFileShortcut(long fileShortcutId) 96 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 97 com.liferay.portal.SystemException { 98 DLFileShortcutServiceUtil.deleteFileShortcut(fileShortcutId); 99 } 100 101 public static JSONObject getFileShortcut(long fileShortcutId) 102 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 103 com.liferay.portal.SystemException { 104 com.liferay.portlet.documentlibrary.model.DLFileShortcut returnValue = DLFileShortcutServiceUtil.getFileShortcut(fileShortcutId); 105 106 return DLFileShortcutJSONSerializer.toJSONObject(returnValue); 107 } 108 109 public static JSONObject updateFileShortcut(long fileShortcutId, 110 long folderId, long toFolderId, java.lang.String toName) 111 throws java.rmi.RemoteException, com.liferay.portal.PortalException, 112 com.liferay.portal.SystemException { 113 com.liferay.portlet.documentlibrary.model.DLFileShortcut returnValue = DLFileShortcutServiceUtil.updateFileShortcut(fileShortcutId, 114 folderId, toFolderId, toName); 115 116 return DLFileShortcutJSONSerializer.toJSONObject(returnValue); 117 } 118 }