| CalEventServiceJSON.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.calendar.service.http;
24
25 import com.liferay.portal.kernel.json.JSONObject;
26
27 import com.liferay.portlet.calendar.service.CalEventServiceUtil;
28
29 /**
30 * <a href="CalEventServiceJSON.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.calendar.service.CalEventServiceUtil</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.calendar.model.CalEvent</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.calendar.service.http.CalEventJSONSerializer</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.calendar.service.CalEventServiceUtil
72 * @see com.liferay.portlet.calendar.service.http.CalEventJSONSerializer
73 *
74 */
75 public class CalEventServiceJSON {
76 public static JSONObject addEvent(java.lang.String title,
77 java.lang.String description, int startDateMonth, int startDateDay,
78 int startDateYear, int startDateHour, int startDateMinute,
79 int endDateMonth, int endDateDay, int endDateYear, int durationHour,
80 int durationMinute, boolean allDay, boolean timeZoneSensitive,
81 java.lang.String type, boolean repeating,
82 com.liferay.portal.kernel.cal.TZSRecurrence recurrence,
83 java.lang.String remindBy, int firstReminder, int secondReminder,
84 com.liferay.portal.service.ServiceContext serviceContext)
85 throws com.liferay.portal.PortalException,
86 com.liferay.portal.SystemException {
87 com.liferay.portlet.calendar.model.CalEvent returnValue = CalEventServiceUtil.addEvent(title,
88 description, startDateMonth, startDateDay, startDateYear,
89 startDateHour, startDateMinute, endDateMonth, endDateDay,
90 endDateYear, durationHour, durationMinute, allDay,
91 timeZoneSensitive, type, repeating, recurrence, remindBy,
92 firstReminder, secondReminder, serviceContext);
93
94 return CalEventJSONSerializer.toJSONObject(returnValue);
95 }
96
97 public static void deleteEvent(long eventId)
98 throws com.liferay.portal.PortalException,
99 com.liferay.portal.SystemException {
100 CalEventServiceUtil.deleteEvent(eventId);
101 }
102
103 public static JSONObject getEvent(long eventId)
104 throws com.liferay.portal.PortalException,
105 com.liferay.portal.SystemException {
106 com.liferay.portlet.calendar.model.CalEvent returnValue = CalEventServiceUtil.getEvent(eventId);
107
108 return CalEventJSONSerializer.toJSONObject(returnValue);
109 }
110
111 public static JSONObject updateEvent(long eventId, java.lang.String title,
112 java.lang.String description, int startDateMonth, int startDateDay,
113 int startDateYear, int startDateHour, int startDateMinute,
114 int endDateMonth, int endDateDay, int endDateYear, int durationHour,
115 int durationMinute, boolean allDay, boolean timeZoneSensitive,
116 java.lang.String type, boolean repeating,
117 com.liferay.portal.kernel.cal.TZSRecurrence recurrence,
118 java.lang.String remindBy, int firstReminder, int secondReminder)
119 throws com.liferay.portal.PortalException,
120 com.liferay.portal.SystemException {
121 com.liferay.portlet.calendar.model.CalEvent returnValue = CalEventServiceUtil.updateEvent(eventId,
122 title, description, startDateMonth, startDateDay,
123 startDateYear, startDateHour, startDateMinute, endDateMonth,
124 endDateDay, endDateYear, durationHour, durationMinute, allDay,
125 timeZoneSensitive, type, repeating, recurrence, remindBy,
126 firstReminder, secondReminder);
127
128 return CalEventJSONSerializer.toJSONObject(returnValue);
129 }
130 }