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.portal.service.http;
24  
25  import com.liferay.portal.service.LayoutServiceUtil;
26  
27  import org.json.JSONObject;
28  
29  /**
30   * <a href="LayoutServiceJSON.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.portal.service.LayoutServiceUtil</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.portal.model.Layout</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.portal.service.http.LayoutJSONSerializer</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.portal.service.LayoutServiceUtil
70   * @see com.liferay.portal.service.http.LayoutJSONSerializer
71   *
72   */
73  public class LayoutServiceJSON {
74      public static JSONObject addLayout(long groupId, boolean privateLayout,
75          long parentLayoutId, java.lang.String name, java.lang.String title,
76          java.lang.String description, java.lang.String type, boolean hidden,
77          java.lang.String friendlyURL)
78          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException {
80          com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.addLayout(groupId,
81                  privateLayout, parentLayoutId, name, title, description, type,
82                  hidden, friendlyURL);
83  
84          return LayoutJSONSerializer.toJSONObject(returnValue);
85      }
86  
87      public static void deleteLayout(long plid)
88          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
89              com.liferay.portal.PortalException {
90          LayoutServiceUtil.deleteLayout(plid);
91      }
92  
93      public static void deleteLayout(long groupId, boolean privateLayout,
94          long layoutId)
95          throws java.rmi.RemoteException, com.liferay.portal.SystemException,
96              com.liferay.portal.PortalException {
97          LayoutServiceUtil.deleteLayout(groupId, privateLayout, layoutId);
98      }
99  
100     public static java.lang.String getLayoutName(long groupId,
101         boolean privateLayout, long layoutId, java.lang.String languageId)
102         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
103             com.liferay.portal.PortalException {
104         java.lang.String returnValue = LayoutServiceUtil.getLayoutName(groupId,
105                 privateLayout, layoutId, languageId);
106 
107         return returnValue;
108     }
109 
110     public static com.liferay.portal.model.LayoutReference[] getLayoutReferences(
111         long companyId, java.lang.String portletId, java.lang.String prefsKey,
112         java.lang.String prefsValue)
113         throws java.rmi.RemoteException, com.liferay.portal.SystemException {
114         com.liferay.portal.model.LayoutReference[] returnValue = LayoutServiceUtil.getLayoutReferences(companyId,
115                 portletId, prefsKey, prefsValue);
116 
117         return returnValue;
118     }
119 
120     public static void setLayouts(long groupId, boolean privateLayout,
121         long parentLayoutId, long[] layoutIds)
122         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
123             com.liferay.portal.PortalException {
124         LayoutServiceUtil.setLayouts(groupId, privateLayout, parentLayoutId,
125             layoutIds);
126     }
127 
128     public static JSONObject updateLayout(long groupId, boolean privateLayout,
129         long layoutId, java.lang.String typeSettings)
130         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
131             com.liferay.portal.PortalException {
132         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updateLayout(groupId,
133                 privateLayout, layoutId, typeSettings);
134 
135         return LayoutJSONSerializer.toJSONObject(returnValue);
136     }
137 
138     public static JSONObject updateLookAndFeel(long groupId,
139         boolean privateLayout, long layoutId, java.lang.String themeId,
140         java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
141         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
142             com.liferay.portal.PortalException {
143         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updateLookAndFeel(groupId,
144                 privateLayout, layoutId, themeId, colorSchemeId, css, wapTheme);
145 
146         return LayoutJSONSerializer.toJSONObject(returnValue);
147     }
148 
149     public static JSONObject updateName(long plid, java.lang.String name,
150         java.lang.String languageId)
151         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
152             com.liferay.portal.PortalException {
153         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updateName(plid,
154                 name, languageId);
155 
156         return LayoutJSONSerializer.toJSONObject(returnValue);
157     }
158 
159     public static JSONObject updateName(long groupId, boolean privateLayout,
160         long layoutId, java.lang.String name, java.lang.String languageId)
161         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
162             com.liferay.portal.PortalException {
163         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updateName(groupId,
164                 privateLayout, layoutId, name, languageId);
165 
166         return LayoutJSONSerializer.toJSONObject(returnValue);
167     }
168 
169     public static JSONObject updateParentLayoutId(long plid, long parentPlid)
170         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
171             com.liferay.portal.PortalException {
172         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updateParentLayoutId(plid,
173                 parentPlid);
174 
175         return LayoutJSONSerializer.toJSONObject(returnValue);
176     }
177 
178     public static JSONObject updateParentLayoutId(long groupId,
179         boolean privateLayout, long layoutId, long parentLayoutId)
180         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
181             com.liferay.portal.PortalException {
182         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updateParentLayoutId(groupId,
183                 privateLayout, layoutId, parentLayoutId);
184 
185         return LayoutJSONSerializer.toJSONObject(returnValue);
186     }
187 
188     public static JSONObject updatePriority(long plid, int priority)
189         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
190             com.liferay.portal.PortalException {
191         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updatePriority(plid,
192                 priority);
193 
194         return LayoutJSONSerializer.toJSONObject(returnValue);
195     }
196 
197     public static JSONObject updatePriority(long groupId,
198         boolean privateLayout, long layoutId, int priority)
199         throws java.rmi.RemoteException, com.liferay.portal.SystemException,
200             com.liferay.portal.PortalException {
201         com.liferay.portal.model.Layout returnValue = LayoutServiceUtil.updatePriority(groupId,
202                 privateLayout, layoutId, priority);
203 
204         return LayoutJSONSerializer.toJSONObject(returnValue);
205     }
206 }