1   /**
2    * Copyright (c) 2000-2007 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.messageboards.service.http;
24  
25  import com.liferay.portlet.messageboards.service.MBMessageServiceUtil;
26  
27  import org.json.JSONObject;
28  
29  /**
30   * <a href="MBMessageServiceJSON.java.html"><b><i>View Source</i></b></a>
31   *
32   * <p>
33   * ServiceBuilder generated this class. Modifications in this class will be overwritten
34   * the next time is generated.
35   * </p>
36   *
37   * <p>
38   * This class provides a JSON utility for the <code>com.liferay.portlet.messageboards.service.MBMessageServiceUtil</code>
39   * service utility. The static methods of this class calls the same methods of the
40   * service utility. However, the signatures are different because it is difficult
41   * for JSON to support certain types.
42   * </p>
43   *
44   * <p>
45   * ServiceBuilder follows certain rules in translating the methods. For example,
46   * if the method in the service utility returns a <code>java.util.List</code>, that
47   * is translated to a <code>org.json.JSONArray</code>. If the method in the service
48   * utility returns a <code>com.liferay.portlet.messageboards.model.MBMessage</code>,
49   * that is translated to a <code>org.json.JSONObject</code>. Methods that JSON cannot
50   * safely use are skipped. The logic for the translation is encapsulated in <code>com.liferay.portlet.messageboards.service.http.MBMessageJSONSerializer</code>.
51   * </p>
52   *
53   * <p>
54   * This allows you to call the the backend services directly from JavaScript. See
55   * <code>portal-web/docroot/html/portlet/tags_admin/unpacked.js</code> for a reference
56   * of how that portlet uses the generated JavaScript in <code>portal-web/docroot/html/js/service.js</code>
57   * to call the backend services directly from JavaScript.
58   * </p>
59   *
60   * <p>
61   * The JSON utility is only generated for remote services.
62   * </p>
63   *
64   * @author Brian Wing Shun Chan
65   *
66   * @see com.liferay.portlet.messageboards.service.MBMessageServiceUtil
67   * @see com.liferay.portlet.messageboards.service.http.MBMessageJSONSerializer
68   *
69   */
70  public class MBMessageServiceJSON {
71      public static JSONObject addMessage(long categoryId,
72          java.lang.String subject, java.lang.String body, java.util.List files,
73          boolean anonymous, double priority, java.lang.String[] tagsEntries,
74          boolean addCommunityPermissions, boolean addGuestPermissions)
75          throws com.liferay.portal.SystemException, 
76              com.liferay.portal.PortalException, java.rmi.RemoteException {
77          com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
78                  subject, body, files, anonymous, priority, tagsEntries,
79                  addCommunityPermissions, addGuestPermissions);
80  
81          return MBMessageJSONSerializer.toJSONObject(returnValue);
82      }
83  
84      public static JSONObject addMessage(long categoryId, long threadId,
85          long parentMessageId, java.lang.String subject, java.lang.String body,
86          java.util.List files, boolean anonymous, double priority,
87          java.lang.String[] tagsEntries, boolean addCommunityPermissions,
88          boolean addGuestPermissions)
89          throws com.liferay.portal.SystemException, 
90              com.liferay.portal.PortalException, java.rmi.RemoteException {
91          com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
92                  threadId, parentMessageId, subject, body, files, anonymous,
93                  priority, tagsEntries, addCommunityPermissions,
94                  addGuestPermissions);
95  
96          return MBMessageJSONSerializer.toJSONObject(returnValue);
97      }
98  
99      public static JSONObject addMessage(long categoryId,
100         java.lang.String subject, java.lang.String body, java.util.List files,
101         boolean anonymous, double priority, java.lang.String[] tagsEntries,
102         java.lang.String[] communityPermissions,
103         java.lang.String[] guestPermissions)
104         throws com.liferay.portal.SystemException, 
105             com.liferay.portal.PortalException, java.rmi.RemoteException {
106         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
107                 subject, body, files, anonymous, priority, tagsEntries,
108                 communityPermissions, guestPermissions);
109 
110         return MBMessageJSONSerializer.toJSONObject(returnValue);
111     }
112 
113     public static JSONObject addMessage(long categoryId, long threadId,
114         long parentMessageId, java.lang.String subject, java.lang.String body,
115         java.util.List files, boolean anonymous, double priority,
116         java.lang.String[] tagsEntries,
117         java.lang.String[] communityPermissions,
118         java.lang.String[] guestPermissions)
119         throws com.liferay.portal.SystemException, 
120             com.liferay.portal.PortalException, java.rmi.RemoteException {
121         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
122                 threadId, parentMessageId, subject, body, files, anonymous,
123                 priority, tagsEntries, communityPermissions, guestPermissions);
124 
125         return MBMessageJSONSerializer.toJSONObject(returnValue);
126     }
127 
128     public static void deleteDiscussionMessage(long groupId,
129         java.lang.String className, long classPK, long messageId)
130         throws com.liferay.portal.SystemException, 
131             com.liferay.portal.PortalException, java.rmi.RemoteException {
132         MBMessageServiceUtil.deleteDiscussionMessage(groupId, className,
133             classPK, messageId);
134     }
135 
136     public static void deleteMessage(long messageId)
137         throws com.liferay.portal.SystemException, 
138             com.liferay.portal.PortalException, java.rmi.RemoteException {
139         MBMessageServiceUtil.deleteMessage(messageId);
140     }
141 
142     public static JSONObject getMessage(long messageId)
143         throws com.liferay.portal.SystemException, 
144             com.liferay.portal.PortalException, java.rmi.RemoteException {
145         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.getMessage(messageId);
146 
147         return MBMessageJSONSerializer.toJSONObject(returnValue);
148     }
149 
150     public static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(
151         long messageId)
152         throws com.liferay.portal.SystemException, 
153             com.liferay.portal.PortalException, java.rmi.RemoteException {
154         com.liferay.portlet.messageboards.model.MBMessageDisplay returnValue = MBMessageServiceUtil.getMessageDisplay(messageId);
155 
156         return returnValue;
157     }
158 
159     public static void subscribeMessage(long messageId)
160         throws com.liferay.portal.SystemException, 
161             com.liferay.portal.PortalException, java.rmi.RemoteException {
162         MBMessageServiceUtil.subscribeMessage(messageId);
163     }
164 
165     public static void unsubscribeMessage(long messageId)
166         throws com.liferay.portal.SystemException, 
167             com.liferay.portal.PortalException, java.rmi.RemoteException {
168         MBMessageServiceUtil.unsubscribeMessage(messageId);
169     }
170 
171     public static JSONObject updateDiscussionMessage(long groupId,
172         java.lang.String className, long classPK, long messageId,
173         java.lang.String subject, java.lang.String body)
174         throws com.liferay.portal.SystemException, 
175             com.liferay.portal.PortalException, java.rmi.RemoteException {
176         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.updateDiscussionMessage(groupId,
177                 className, classPK, messageId, subject, body);
178 
179         return MBMessageJSONSerializer.toJSONObject(returnValue);
180     }
181 
182     public static JSONObject updateMessage(long messageId, long categoryId,
183         java.lang.String subject, java.lang.String body, java.util.List files,
184         double priority, java.lang.String[] tagsEntries)
185         throws com.liferay.portal.SystemException, 
186             com.liferay.portal.PortalException, java.rmi.RemoteException {
187         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.updateMessage(messageId,
188                 categoryId, subject, body, files, priority, tagsEntries);
189 
190         return MBMessageJSONSerializer.toJSONObject(returnValue);
191     }
192 }