AnnouncementsEntryServiceJSON.java |
1 /** 2 * Copyright (c) 2000-2008 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.announcements.service.http; 24 25 import com.liferay.portlet.announcements.service.AnnouncementsEntryServiceUtil; 26 27 import org.json.JSONObject; 28 29 /** 30 * <a href="AnnouncementsEntryServiceJSON.java.html"><b><i>View Source</i></b></a> 31 * 32 * <p> 33 * ServiceBuilder generated this class. Modifications in this class will be 34 * overwritten the next time is generated. 35 * </p> 36 * 37 * <p> 38 * This class provides a JSON utility for the 39 * <code>com.liferay.portlet.announcements.service.AnnouncementsEntryServiceUtil</code> 40 * service utility. The static methods of this class calls the same methods of 41 * the service utility. However, the signatures are different because it is 42 * difficult for JSON to support certain types. 43 * </p> 44 * 45 * <p> 46 * ServiceBuilder follows certain rules in translating the methods. For example, 47 * if the method in the service utility returns a <code>java.util.List</code>, 48 * that is translated to a <code>org.json.JSONArray</code>. If the method in the 49 * service utility returns a <code>com.liferay.portlet.announcements.model.AnnouncementsEntry</code>, 50 * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON 51 * cannot safely use are skipped. The logic for the translation is encapsulated 52 * in <code>com.liferay.portlet.announcements.service.http.AnnouncementsEntryJSONSerializer</code>. 53 * </p> 54 * 55 * <p> 56 * This allows you to call the the backend services directly from JavaScript. 57 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a 58 * reference of how that portlet uses the generated JavaScript in 59 * <code>portal-web/docroot/html/js/service.js</code> to call the backend 60 * services directly from JavaScript. 61 * </p> 62 * 63 * <p> 64 * The JSON utility is only generated for remote services. 65 * </p> 66 * 67 * @author Brian Wing Shun Chan 68 * 69 * @see com.liferay.portlet.announcements.service.AnnouncementsEntryServiceUtil 70 * @see com.liferay.portlet.announcements.service.http.AnnouncementsEntryJSONSerializer 71 * 72 */ 73 public class AnnouncementsEntryServiceJSON { 74 public static JSONObject addEntry(long plid, long classNameId, 75 long classPK, java.lang.String title, java.lang.String content, 76 java.lang.String url, java.lang.String type, int displayDateMonth, 77 int displayDateDay, int displayDateYear, int displayDateHour, 78 int displayDateMinute, int expirationDateMonth, int expirationDateDay, 79 int expirationDateYear, int expirationDateHour, 80 int expirationDateMinute, int priority, boolean alert) 81 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 82 com.liferay.portal.PortalException { 83 com.liferay.portlet.announcements.model.AnnouncementsEntry returnValue = AnnouncementsEntryServiceUtil.addEntry(plid, 84 classNameId, classPK, title, content, url, type, 85 displayDateMonth, displayDateDay, displayDateYear, 86 displayDateHour, displayDateMinute, expirationDateMonth, 87 expirationDateDay, expirationDateYear, expirationDateHour, 88 expirationDateMinute, priority, alert); 89 90 return AnnouncementsEntryJSONSerializer.toJSONObject(returnValue); 91 } 92 93 public static void deleteEntry(long entryId) 94 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 95 com.liferay.portal.PortalException { 96 AnnouncementsEntryServiceUtil.deleteEntry(entryId); 97 } 98 99 public static JSONObject updateEntry(long entryId, java.lang.String title, 100 java.lang.String content, java.lang.String url, java.lang.String type, 101 int displayDateMonth, int displayDateDay, int displayDateYear, 102 int displayDateHour, int displayDateMinute, int expirationDateMonth, 103 int expirationDateDay, int expirationDateYear, int expirationDateHour, 104 int expirationDateMinute, int priority) 105 throws java.rmi.RemoteException, com.liferay.portal.SystemException, 106 com.liferay.portal.PortalException { 107 com.liferay.portlet.announcements.model.AnnouncementsEntry returnValue = AnnouncementsEntryServiceUtil.updateEntry(entryId, 108 title, content, url, type, displayDateMonth, displayDateDay, 109 displayDateYear, displayDateHour, displayDateMinute, 110 expirationDateMonth, expirationDateDay, expirationDateYear, 111 expirationDateHour, expirationDateMinute, priority); 112 113 return AnnouncementsEntryJSONSerializer.toJSONObject(returnValue); 114 } 115 }