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