| AnnouncementsEntryServiceJSON.java |
1 /**
2 * Copyright (c) 2000-2009 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.portal.kernel.json.JSONObject;
26
27 import com.liferay.portlet.announcements.service.AnnouncementsEntryServiceUtil;
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
49 * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
50 * service utility returns a <code>com.liferay.portlet.announcements.model.AnnouncementsEntry</code>,
51 * that is translated to a
52 * <code>com.liferay.portal.kernel.json.JSONObject</code>. Methods that JSON
53 * cannot safely use are skipped. The logic for the translation is encapsulated
54 * in <code>com.liferay.portlet.announcements.service.http.AnnouncementsEntryJSONSerializer</code>.
55 * </p>
56 *
57 * <p>
58 * This allows you to call the the backend services directly from JavaScript.
59 * See <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a
60 * reference of how that portlet uses the generated JavaScript in
61 * <code>portal-web/docroot/html/js/service.js</code> to call the backend
62 * services directly from JavaScript.
63 * </p>
64 *
65 * <p>
66 * The JSON utility is only generated for remote services.
67 * </p>
68 *
69 * @author Brian Wing Shun Chan
70 *
71 * @see com.liferay.portlet.announcements.service.AnnouncementsEntryServiceUtil
72 * @see com.liferay.portlet.announcements.service.http.AnnouncementsEntryJSONSerializer
73 *
74 */
75 public class AnnouncementsEntryServiceJSON {
76 public static JSONObject addEntry(long plid, long classNameId,
77 long classPK, java.lang.String title, java.lang.String content,
78 java.lang.String url, java.lang.String type, int displayDateMonth,
79 int displayDateDay, int displayDateYear, int displayDateHour,
80 int displayDateMinute, int expirationDateMonth, int expirationDateDay,
81 int expirationDateYear, int expirationDateHour,
82 int expirationDateMinute, int priority, boolean alert)
83 throws com.liferay.portal.PortalException,
84 com.liferay.portal.SystemException {
85 com.liferay.portlet.announcements.model.AnnouncementsEntry returnValue = AnnouncementsEntryServiceUtil.addEntry(plid,
86 classNameId, classPK, title, content, url, type,
87 displayDateMonth, displayDateDay, displayDateYear,
88 displayDateHour, displayDateMinute, expirationDateMonth,
89 expirationDateDay, expirationDateYear, expirationDateHour,
90 expirationDateMinute, priority, alert);
91
92 return AnnouncementsEntryJSONSerializer.toJSONObject(returnValue);
93 }
94
95 public static void deleteEntry(long entryId)
96 throws com.liferay.portal.PortalException,
97 com.liferay.portal.SystemException {
98 AnnouncementsEntryServiceUtil.deleteEntry(entryId);
99 }
100
101 public static JSONObject updateEntry(long entryId, java.lang.String title,
102 java.lang.String content, java.lang.String url, java.lang.String type,
103 int displayDateMonth, int displayDateDay, int displayDateYear,
104 int displayDateHour, int displayDateMinute, int expirationDateMonth,
105 int expirationDateDay, int expirationDateYear, int expirationDateHour,
106 int expirationDateMinute, int priority)
107 throws com.liferay.portal.PortalException,
108 com.liferay.portal.SystemException {
109 com.liferay.portlet.announcements.model.AnnouncementsEntry returnValue = AnnouncementsEntryServiceUtil.updateEntry(entryId,
110 title, content, url, type, displayDateMonth, displayDateDay,
111 displayDateYear, displayDateHour, displayDateMinute,
112 expirationDateMonth, expirationDateDay, expirationDateYear,
113 expirationDateHour, expirationDateMinute, priority);
114
115 return AnnouncementsEntryJSONSerializer.toJSONObject(returnValue);
116 }
117 }