1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portlet.messageboards.service.http;
21  
22  import com.liferay.portal.kernel.json.JSONArray;
23  import com.liferay.portal.kernel.json.JSONObject;
24  
25  import com.liferay.portlet.messageboards.service.MBMessageServiceUtil;
26  
27  /**
28   * <a href="MBMessageServiceJSON.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This class provides a JSON utility for the
37   * <code>com.liferay.portlet.messageboards.service.MBMessageServiceUtil</code>
38   * service utility. The static methods of this class calls the same methods of
39   * the service utility. However, the signatures are different because it is
40   * difficult for JSON to support certain types.
41   * </p>
42   *
43   * <p>
44   * ServiceBuilder follows certain rules in translating the methods. For example,
45   * if the method in the service utility returns a <code>java.util.List</code>,
46   * that is translated to a
47   * <code>com.liferay.portal.kernel.json.JSONArray</code>. If the method in the
48   * service utility returns a <code>com.liferay.portlet.messageboards.model.MBMessage</code>,
49   * that is translated to a
50   * <code>com.liferay.portal.kernel.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.messageboards.service.http.MBMessageJSONSerializer</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.messageboards.service.MBMessageServiceUtil
70   * @see com.liferay.portlet.messageboards.service.http.MBMessageJSONSerializer
71   *
72   */
73  public class MBMessageServiceJSON {
74      public static JSONObject addMessage(long categoryId,
75          java.lang.String subject, java.lang.String body,
76          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
77          boolean anonymous, double priority, java.lang.String[] tagsEntries,
78          boolean addCommunityPermissions, boolean addGuestPermissions)
79          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
80              com.liferay.portal.SystemException {
81          com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
82                  subject, body, files, anonymous, priority, tagsEntries,
83                  addCommunityPermissions, addGuestPermissions);
84  
85          return MBMessageJSONSerializer.toJSONObject(returnValue);
86      }
87  
88      public static JSONObject addMessage(long categoryId,
89          java.lang.String subject, java.lang.String body,
90          java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
91          boolean anonymous, double priority, java.lang.String[] tagsEntries,
92          java.lang.String[] communityPermissions,
93          java.lang.String[] guestPermissions)
94          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
95              com.liferay.portal.SystemException {
96          com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
97                  subject, body, files, anonymous, priority, tagsEntries,
98                  communityPermissions, guestPermissions);
99  
100         return MBMessageJSONSerializer.toJSONObject(returnValue);
101     }
102 
103     public static JSONObject addMessage(long categoryId, long threadId,
104         long parentMessageId, java.lang.String subject, java.lang.String body,
105         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
106         boolean anonymous, double priority, java.lang.String[] tagsEntries,
107         boolean addCommunityPermissions, boolean addGuestPermissions)
108         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
109             com.liferay.portal.SystemException {
110         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
111                 threadId, parentMessageId, subject, body, files, anonymous,
112                 priority, tagsEntries, addCommunityPermissions,
113                 addGuestPermissions);
114 
115         return MBMessageJSONSerializer.toJSONObject(returnValue);
116     }
117 
118     public static JSONObject addMessage(long categoryId, long threadId,
119         long parentMessageId, java.lang.String subject, java.lang.String body,
120         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
121         boolean anonymous, double priority, java.lang.String[] tagsEntries,
122         java.lang.String[] communityPermissions,
123         java.lang.String[] guestPermissions)
124         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
125             com.liferay.portal.SystemException {
126         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.addMessage(categoryId,
127                 threadId, parentMessageId, subject, body, files, anonymous,
128                 priority, tagsEntries, communityPermissions, guestPermissions);
129 
130         return MBMessageJSONSerializer.toJSONObject(returnValue);
131     }
132 
133     public static void deleteDiscussionMessage(long groupId,
134         java.lang.String className, long classPK, long messageId)
135         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
136             com.liferay.portal.SystemException {
137         MBMessageServiceUtil.deleteDiscussionMessage(groupId, className,
138             classPK, messageId);
139     }
140 
141     public static void deleteMessage(long messageId)
142         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException {
144         MBMessageServiceUtil.deleteMessage(messageId);
145     }
146 
147     public static JSONArray getCategoryMessages(long categoryId, int start,
148         int end)
149         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
150             com.liferay.portal.SystemException {
151         java.util.List<com.liferay.portlet.messageboards.model.MBMessage> returnValue =
152             MBMessageServiceUtil.getCategoryMessages(categoryId, start, end);
153 
154         return MBMessageJSONSerializer.toJSONArray(returnValue);
155     }
156 
157     public static int getCategoryMessagesCount(long categoryId)
158         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
159         int returnValue = MBMessageServiceUtil.getCategoryMessagesCount(categoryId);
160 
161         return returnValue;
162     }
163 
164     public static JSONObject getMessage(long messageId)
165         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
166             com.liferay.portal.SystemException {
167         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.getMessage(messageId);
168 
169         return MBMessageJSONSerializer.toJSONObject(returnValue);
170     }
171 
172     public static com.liferay.portlet.messageboards.model.MBMessageDisplay getMessageDisplay(
173         long messageId)
174         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
175             com.liferay.portal.SystemException {
176         com.liferay.portlet.messageboards.model.MBMessageDisplay returnValue = MBMessageServiceUtil.getMessageDisplay(messageId);
177 
178         return returnValue;
179     }
180 
181     public static void subscribeMessage(long messageId)
182         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
183             com.liferay.portal.SystemException {
184         MBMessageServiceUtil.subscribeMessage(messageId);
185     }
186 
187     public static void unsubscribeMessage(long messageId)
188         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
189             com.liferay.portal.SystemException {
190         MBMessageServiceUtil.unsubscribeMessage(messageId);
191     }
192 
193     public static JSONObject updateDiscussionMessage(long groupId,
194         java.lang.String className, long classPK, long messageId,
195         java.lang.String subject, java.lang.String body)
196         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
197             com.liferay.portal.SystemException {
198         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.updateDiscussionMessage(groupId,
199                 className, classPK, messageId, subject, body);
200 
201         return MBMessageJSONSerializer.toJSONObject(returnValue);
202     }
203 
204     public static JSONObject updateMessage(long messageId,
205         java.lang.String subject, java.lang.String body,
206         java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<String, byte[]>> files,
207         java.util.List<String> existingFiles, double priority,
208         java.lang.String[] tagsEntries)
209         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
210             com.liferay.portal.SystemException {
211         com.liferay.portlet.messageboards.model.MBMessage returnValue = MBMessageServiceUtil.updateMessage(messageId,
212                 subject, body, files, existingFiles, priority, tagsEntries);
213 
214         return MBMessageJSONSerializer.toJSONObject(returnValue);
215     }
216 }