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