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.portlet.journal.service.http;
24  
25  import com.liferay.portal.kernel.json.JSONObject;
26  
27  import com.liferay.portlet.journal.service.JournalArticleServiceUtil;
28  
29  /**
30   * <a href="JournalArticleServiceJSON.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.journal.service.JournalArticleServiceUtil</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.journal.model.JournalArticle</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.journal.service.http.JournalArticleJSONSerializer</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.journal.service.JournalArticleServiceUtil
72   * @see com.liferay.portlet.journal.service.http.JournalArticleJSONSerializer
73   *
74   */
75  public class JournalArticleServiceJSON {
76      public static JSONObject addArticle(java.lang.String articleId,
77          boolean autoArticleId, long plid, java.lang.String title,
78          java.lang.String description, java.lang.String content,
79          java.lang.String type, java.lang.String structureId,
80          java.lang.String templateId, int displayDateMonth, int displayDateDay,
81          int displayDateYear, int displayDateHour, int displayDateMinute,
82          int expirationDateMonth, int expirationDateDay, int expirationDateYear,
83          int expirationDateHour, int expirationDateMinute, boolean neverExpire,
84          int reviewDateMonth, int reviewDateDay, int reviewDateYear,
85          int reviewDateHour, int reviewDateMinute, boolean neverReview,
86          boolean indexable, java.lang.String articleURL,
87          java.lang.String[] tagsEntries, boolean addCommunityPermissions,
88          boolean addGuestPermissions)
89          throws java.rmi.RemoteException, com.liferay.portal.PortalException,
90              com.liferay.portal.SystemException {
91          com.liferay.portlet.journal.model.JournalArticle returnValue = JournalArticleServiceUtil.addArticle(articleId,
92                  autoArticleId, plid, title, description, content, type,
93                  structureId, templateId, displayDateMonth, displayDateDay,
94                  displayDateYear, displayDateHour, displayDateMinute,
95                  expirationDateMonth, expirationDateDay, expirationDateYear,
96                  expirationDateHour, expirationDateMinute, neverExpire,
97                  reviewDateMonth, reviewDateDay, reviewDateYear, reviewDateHour,
98                  reviewDateMinute, neverReview, indexable, articleURL,
99                  tagsEntries, addCommunityPermissions, addGuestPermissions);
100 
101         return JournalArticleJSONSerializer.toJSONObject(returnValue);
102     }
103 
104     public static JSONObject addArticle(java.lang.String articleId,
105         boolean autoArticleId, long plid, java.lang.String title,
106         java.lang.String description, java.lang.String content,
107         java.lang.String type, java.lang.String structureId,
108         java.lang.String templateId, int displayDateMonth, int displayDateDay,
109         int displayDateYear, int displayDateHour, int displayDateMinute,
110         int expirationDateMonth, int expirationDateDay, int expirationDateYear,
111         int expirationDateHour, int expirationDateMinute, boolean neverExpire,
112         int reviewDateMonth, int reviewDateDay, int reviewDateYear,
113         int reviewDateHour, int reviewDateMinute, boolean neverReview,
114         boolean indexable, java.lang.String articleURL,
115         java.lang.String[] tagsEntries,
116         java.lang.String[] communityPermissions,
117         java.lang.String[] guestPermissions)
118         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
119             com.liferay.portal.SystemException {
120         com.liferay.portlet.journal.model.JournalArticle returnValue = JournalArticleServiceUtil.addArticle(articleId,
121                 autoArticleId, plid, title, description, content, type,
122                 structureId, templateId, displayDateMonth, displayDateDay,
123                 displayDateYear, displayDateHour, displayDateMinute,
124                 expirationDateMonth, expirationDateDay, expirationDateYear,
125                 expirationDateHour, expirationDateMinute, neverExpire,
126                 reviewDateMonth, reviewDateDay, reviewDateYear, reviewDateHour,
127                 reviewDateMinute, neverReview, indexable, articleURL,
128                 tagsEntries, communityPermissions, guestPermissions);
129 
130         return JournalArticleJSONSerializer.toJSONObject(returnValue);
131     }
132 
133     public static JSONObject copyArticle(long groupId,
134         java.lang.String oldArticleId, java.lang.String newArticleId,
135         boolean autoArticleId, double version)
136         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
137             com.liferay.portal.SystemException {
138         com.liferay.portlet.journal.model.JournalArticle returnValue = JournalArticleServiceUtil.copyArticle(groupId,
139                 oldArticleId, newArticleId, autoArticleId, version);
140 
141         return JournalArticleJSONSerializer.toJSONObject(returnValue);
142     }
143 
144     public static JSONObject getArticle(long groupId,
145         java.lang.String articleId, double version)
146         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
147             com.liferay.portal.SystemException {
148         com.liferay.portlet.journal.model.JournalArticle returnValue = JournalArticleServiceUtil.getArticle(groupId,
149                 articleId, version);
150 
151         return JournalArticleJSONSerializer.toJSONObject(returnValue);
152     }
153 
154     public static void removeArticleLocale(long companyId,
155         java.lang.String languageId)
156         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
157             com.liferay.portal.SystemException {
158         JournalArticleServiceUtil.removeArticleLocale(companyId, languageId);
159     }
160 
161     public static JSONObject removeArticleLocale(long groupId,
162         java.lang.String articleId, double version, java.lang.String languageId)
163         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException {
165         com.liferay.portlet.journal.model.JournalArticle returnValue = JournalArticleServiceUtil.removeArticleLocale(groupId,
166                 articleId, version, languageId);
167 
168         return JournalArticleJSONSerializer.toJSONObject(returnValue);
169     }
170 
171     public static JSONObject updateContent(long groupId,
172         java.lang.String articleId, double version, java.lang.String content)
173         throws java.rmi.RemoteException, com.liferay.portal.PortalException,
174             com.liferay.portal.SystemException {
175         com.liferay.portlet.journal.model.JournalArticle returnValue = JournalArticleServiceUtil.updateContent(groupId,
176                 articleId, version, content);
177 
178         return JournalArticleJSONSerializer.toJSONObject(returnValue);
179     }
180 }