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.journal.service.http;
24  
25  import com.liferay.portal.kernel.json.JSONObject;
26  
27  import com.liferay.portlet.journal.service.JournalFeedServiceUtil;
28  
29  /**
30   * <a href="JournalFeedServiceJSON.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.JournalFeedServiceUtil</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.JournalFeed</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.JournalFeedJSONSerializer</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.JournalFeedServiceUtil
72   * @see com.liferay.portlet.journal.service.http.JournalFeedJSONSerializer
73   *
74   */
75  public class JournalFeedServiceJSON {
76      public static JSONObject addFeed(long groupId, java.lang.String feedId,
77          boolean autoFeedId, java.lang.String name,
78          java.lang.String description, java.lang.String type,
79          java.lang.String structureId, java.lang.String templateId,
80          java.lang.String rendererTemplateId, int delta,
81          java.lang.String orderByCol, java.lang.String orderByType,
82          java.lang.String targetLayoutFriendlyUrl,
83          java.lang.String targetPortletId, java.lang.String contentField,
84          java.lang.String feedType, double feedVersion,
85          boolean addCommunityPermissions, boolean addGuestPermissions)
86          throws com.liferay.portal.PortalException,
87              com.liferay.portal.SystemException {
88          com.liferay.portlet.journal.model.JournalFeed returnValue = JournalFeedServiceUtil.addFeed(groupId,
89                  feedId, autoFeedId, name, description, type, structureId,
90                  templateId, rendererTemplateId, delta, orderByCol, orderByType,
91                  targetLayoutFriendlyUrl, targetPortletId, contentField,
92                  feedType, feedVersion, addCommunityPermissions,
93                  addGuestPermissions);
94  
95          return JournalFeedJSONSerializer.toJSONObject(returnValue);
96      }
97  
98      public static JSONObject addFeed(long groupId, java.lang.String feedId,
99          boolean autoFeedId, java.lang.String name,
100         java.lang.String description, java.lang.String type,
101         java.lang.String structureId, java.lang.String templateId,
102         java.lang.String rendererTemplateId, int delta,
103         java.lang.String orderByCol, java.lang.String orderByType,
104         java.lang.String targetLayoutFriendlyUrl,
105         java.lang.String targetPortletId, java.lang.String contentField,
106         java.lang.String feedType, double feedVersion,
107         java.lang.String[] communityPermissions,
108         java.lang.String[] guestPermissions)
109         throws com.liferay.portal.PortalException,
110             com.liferay.portal.SystemException {
111         com.liferay.portlet.journal.model.JournalFeed returnValue = JournalFeedServiceUtil.addFeed(groupId,
112                 feedId, autoFeedId, name, description, type, structureId,
113                 templateId, rendererTemplateId, delta, orderByCol, orderByType,
114                 targetLayoutFriendlyUrl, targetPortletId, contentField,
115                 feedType, feedVersion, communityPermissions, guestPermissions);
116 
117         return JournalFeedJSONSerializer.toJSONObject(returnValue);
118     }
119 
120     public static void deleteFeed(long groupId, long feedId)
121         throws com.liferay.portal.PortalException,
122             com.liferay.portal.SystemException {
123         JournalFeedServiceUtil.deleteFeed(groupId, feedId);
124     }
125 
126     public static void deleteFeed(long groupId, java.lang.String feedId)
127         throws com.liferay.portal.PortalException,
128             com.liferay.portal.SystemException {
129         JournalFeedServiceUtil.deleteFeed(groupId, feedId);
130     }
131 
132     public static JSONObject getFeed(long groupId, long feedId)
133         throws com.liferay.portal.PortalException,
134             com.liferay.portal.SystemException {
135         com.liferay.portlet.journal.model.JournalFeed returnValue = JournalFeedServiceUtil.getFeed(groupId,
136                 feedId);
137 
138         return JournalFeedJSONSerializer.toJSONObject(returnValue);
139     }
140 
141     public static JSONObject getFeed(long groupId, java.lang.String feedId)
142         throws com.liferay.portal.PortalException,
143             com.liferay.portal.SystemException {
144         com.liferay.portlet.journal.model.JournalFeed returnValue = JournalFeedServiceUtil.getFeed(groupId,
145                 feedId);
146 
147         return JournalFeedJSONSerializer.toJSONObject(returnValue);
148     }
149 
150     public static JSONObject updateFeed(long groupId, java.lang.String feedId,
151         java.lang.String name, java.lang.String description,
152         java.lang.String type, java.lang.String structureId,
153         java.lang.String templateId, java.lang.String rendererTemplateId,
154         int delta, java.lang.String orderByCol, java.lang.String orderByType,
155         java.lang.String targetLayoutFriendlyUrl,
156         java.lang.String targetPortletId, java.lang.String contentField,
157         java.lang.String feedType, double feedVersion)
158         throws com.liferay.portal.PortalException,
159             com.liferay.portal.SystemException {
160         com.liferay.portlet.journal.model.JournalFeed returnValue = JournalFeedServiceUtil.updateFeed(groupId,
161                 feedId, name, description, type, structureId, templateId,
162                 rendererTemplateId, delta, orderByCol, orderByType,
163                 targetLayoutFriendlyUrl, targetPortletId, contentField,
164                 feedType, feedVersion);
165 
166         return JournalFeedJSONSerializer.toJSONObject(returnValue);
167     }
168 }