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;
24  
25  
26  /**
27   * <a href="LayoutServiceUtil.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This class provides static methods for the
36   * <code>com.liferay.portal.service.LayoutService</code>
37   * bean. The static methods of this class calls the same methods of the bean
38   * instance. It's convenient to be able to just write one line to call a method
39   * on a bean instead of writing a lookup call and a method call.
40   * </p>
41   *
42   * <p>
43   * <code>com.liferay.portal.service.LayoutServiceFactory</code>
44   * is responsible for the lookup of the bean.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.LayoutService
50   * @see com.liferay.portal.service.LayoutServiceFactory
51   *
52   */
53  public class LayoutServiceUtil {
54      public static com.liferay.portal.model.Layout addLayout(long groupId,
55          boolean privateLayout, long parentLayoutId, java.lang.String name,
56          java.lang.String title, java.lang.String description,
57          java.lang.String type, boolean hidden, java.lang.String friendlyURL)
58          throws com.liferay.portal.PortalException,
59              com.liferay.portal.SystemException, java.rmi.RemoteException {
60          LayoutService layoutService = LayoutServiceFactory.getService();
61  
62          return layoutService.addLayout(groupId, privateLayout, parentLayoutId,
63              name, title, description, type, hidden, friendlyURL);
64      }
65  
66      public static com.liferay.portal.model.Layout addLayout(long groupId,
67          boolean privateLayout, long parentLayoutId,
68          java.util.Map<java.util.Locale, String> localeNamesMap,
69          java.util.Map<java.util.Locale, String> localeTitlesMap,
70          java.lang.String description, java.lang.String type, boolean hidden,
71          java.lang.String friendlyURL)
72          throws com.liferay.portal.PortalException,
73              com.liferay.portal.SystemException, java.rmi.RemoteException {
74          LayoutService layoutService = LayoutServiceFactory.getService();
75  
76          return layoutService.addLayout(groupId, privateLayout, parentLayoutId,
77              localeNamesMap, localeTitlesMap, description, type, hidden,
78              friendlyURL);
79      }
80  
81      public static void deleteLayout(long plid)
82          throws com.liferay.portal.PortalException,
83              com.liferay.portal.SystemException, java.rmi.RemoteException {
84          LayoutService layoutService = LayoutServiceFactory.getService();
85  
86          layoutService.deleteLayout(plid);
87      }
88  
89      public static void deleteLayout(long groupId, boolean privateLayout,
90          long layoutId)
91          throws com.liferay.portal.PortalException,
92              com.liferay.portal.SystemException, java.rmi.RemoteException {
93          LayoutService layoutService = LayoutServiceFactory.getService();
94  
95          layoutService.deleteLayout(groupId, privateLayout, layoutId);
96      }
97  
98      public static java.lang.String getLayoutName(long groupId,
99          boolean privateLayout, long layoutId, java.lang.String languageId)
100         throws com.liferay.portal.PortalException,
101             com.liferay.portal.SystemException, java.rmi.RemoteException {
102         LayoutService layoutService = LayoutServiceFactory.getService();
103 
104         return layoutService.getLayoutName(groupId, privateLayout, layoutId,
105             languageId);
106     }
107 
108     public static com.liferay.portal.model.LayoutReference[] getLayoutReferences(
109         long companyId, java.lang.String portletId, java.lang.String prefsKey,
110         java.lang.String prefsValue)
111         throws com.liferay.portal.SystemException, java.rmi.RemoteException {
112         LayoutService layoutService = LayoutServiceFactory.getService();
113 
114         return layoutService.getLayoutReferences(companyId, portletId,
115             prefsKey, prefsValue);
116     }
117 
118     public static byte[] exportLayouts(long groupId, boolean privateLayout,
119         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
120         java.util.Date endDate)
121         throws com.liferay.portal.PortalException,
122             com.liferay.portal.SystemException, java.rmi.RemoteException {
123         LayoutService layoutService = LayoutServiceFactory.getService();
124 
125         return layoutService.exportLayouts(groupId, privateLayout,
126             parameterMap, startDate, endDate);
127     }
128 
129     public static byte[] exportLayouts(long groupId, boolean privateLayout,
130         long[] layoutIds, java.util.Map<String, String[]> parameterMap,
131         java.util.Date startDate, java.util.Date endDate)
132         throws com.liferay.portal.PortalException,
133             com.liferay.portal.SystemException, java.rmi.RemoteException {
134         LayoutService layoutService = LayoutServiceFactory.getService();
135 
136         return layoutService.exportLayouts(groupId, privateLayout, layoutIds,
137             parameterMap, startDate, endDate);
138     }
139 
140     public static byte[] exportPortletInfo(long plid,
141         java.lang.String portletId,
142         java.util.Map<String, String[]> parameterMap, java.util.Date startDate,
143         java.util.Date endDate)
144         throws com.liferay.portal.PortalException,
145             com.liferay.portal.SystemException, java.rmi.RemoteException {
146         LayoutService layoutService = LayoutServiceFactory.getService();
147 
148         return layoutService.exportPortletInfo(plid, portletId, parameterMap,
149             startDate, endDate);
150     }
151 
152     public static void importLayouts(long groupId, boolean privateLayout,
153         java.util.Map<String, String[]> parameterMap, java.io.File file)
154         throws com.liferay.portal.PortalException,
155             com.liferay.portal.SystemException, java.rmi.RemoteException {
156         LayoutService layoutService = LayoutServiceFactory.getService();
157 
158         layoutService.importLayouts(groupId, privateLayout, parameterMap, file);
159     }
160 
161     public static void importLayouts(long groupId, boolean privateLayout,
162         java.util.Map<String, String[]> parameterMap, byte[] bytes)
163         throws com.liferay.portal.PortalException,
164             com.liferay.portal.SystemException, java.rmi.RemoteException {
165         LayoutService layoutService = LayoutServiceFactory.getService();
166 
167         layoutService.importLayouts(groupId, privateLayout, parameterMap, bytes);
168     }
169 
170     public static void importLayouts(long groupId, boolean privateLayout,
171         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
172         throws com.liferay.portal.PortalException,
173             com.liferay.portal.SystemException, java.rmi.RemoteException {
174         LayoutService layoutService = LayoutServiceFactory.getService();
175 
176         layoutService.importLayouts(groupId, privateLayout, parameterMap, is);
177     }
178 
179     public static void importPortletInfo(long plid, java.lang.String portletId,
180         java.util.Map<String, String[]> parameterMap, java.io.File file)
181         throws com.liferay.portal.PortalException,
182             com.liferay.portal.SystemException, java.rmi.RemoteException {
183         LayoutService layoutService = LayoutServiceFactory.getService();
184 
185         layoutService.importPortletInfo(plid, portletId, parameterMap, file);
186     }
187 
188     public static void importPortletInfo(long plid, java.lang.String portletId,
189         java.util.Map<String, String[]> parameterMap, java.io.InputStream is)
190         throws com.liferay.portal.PortalException,
191             com.liferay.portal.SystemException, java.rmi.RemoteException {
192         LayoutService layoutService = LayoutServiceFactory.getService();
193 
194         layoutService.importPortletInfo(plid, portletId, parameterMap, is);
195     }
196 
197     public static void schedulePublishToLive(long sourceGroupId,
198         long targetGroupId, boolean privateLayout,
199         java.util.Map<Long, Boolean> layoutIdMap,
200         java.util.Map<String, String[]> parameterMap, java.lang.String scope,
201         java.util.Date startDate, java.util.Date endDate,
202         java.lang.String groupName, java.lang.String cronText,
203         java.util.Date schedulerStartDate, java.util.Date schedulerEndDate,
204         java.lang.String description)
205         throws com.liferay.portal.PortalException,
206             com.liferay.portal.SystemException, java.rmi.RemoteException {
207         LayoutService layoutService = LayoutServiceFactory.getService();
208 
209         layoutService.schedulePublishToLive(sourceGroupId, targetGroupId,
210             privateLayout, layoutIdMap, parameterMap, scope, startDate,
211             endDate, groupName, cronText, schedulerStartDate, schedulerEndDate,
212             description);
213     }
214 
215     public static void schedulePublishToRemote(long sourceGroupId,
216         boolean privateLayout, java.util.Map<Long, Boolean> layoutIdMap,
217         java.util.Map<String, String[]> parameterMap,
218         java.lang.String remoteAddress, int remotePort,
219         boolean secureConnection, long remoteGroupId,
220         boolean remotePrivateLayout, java.util.Date startDate,
221         java.util.Date endDate, java.lang.String groupName,
222         java.lang.String cronText, java.util.Date schedulerStartDate,
223         java.util.Date schedulerEndDate, java.lang.String description)
224         throws com.liferay.portal.PortalException,
225             com.liferay.portal.SystemException, java.rmi.RemoteException {
226         LayoutService layoutService = LayoutServiceFactory.getService();
227 
228         layoutService.schedulePublishToRemote(sourceGroupId, privateLayout,
229             layoutIdMap, parameterMap, remoteAddress, remotePort,
230             secureConnection, remoteGroupId, remotePrivateLayout, startDate,
231             endDate, groupName, cronText, schedulerStartDate, schedulerEndDate,
232             description);
233     }
234 
235     public static void setLayouts(long groupId, boolean privateLayout,
236         long parentLayoutId, long[] layoutIds)
237         throws com.liferay.portal.PortalException,
238             com.liferay.portal.SystemException, java.rmi.RemoteException {
239         LayoutService layoutService = LayoutServiceFactory.getService();
240 
241         layoutService.setLayouts(groupId, privateLayout, parentLayoutId,
242             layoutIds);
243     }
244 
245     public static void unschedulePublishToLive(long groupId,
246         java.lang.String jobName, java.lang.String groupName)
247         throws com.liferay.portal.PortalException,
248             com.liferay.portal.SystemException, java.rmi.RemoteException {
249         LayoutService layoutService = LayoutServiceFactory.getService();
250 
251         layoutService.unschedulePublishToLive(groupId, jobName, groupName);
252     }
253 
254     public static void unschedulePublishToRemote(long groupId,
255         java.lang.String jobName, java.lang.String groupName)
256         throws com.liferay.portal.PortalException,
257             com.liferay.portal.SystemException, java.rmi.RemoteException {
258         LayoutService layoutService = LayoutServiceFactory.getService();
259 
260         layoutService.unschedulePublishToRemote(groupId, jobName, groupName);
261     }
262 
263     public static com.liferay.portal.model.Layout updateLayout(long groupId,
264         boolean privateLayout, long layoutId, long parentLayoutId,
265         java.util.Map<java.util.Locale, String> localeNamesMap,
266         java.util.Map<java.util.Locale, String> localeTitlesMap,
267         java.lang.String description, java.lang.String type, boolean hidden,
268         java.lang.String friendlyURL)
269         throws com.liferay.portal.PortalException,
270             com.liferay.portal.SystemException, java.rmi.RemoteException {
271         LayoutService layoutService = LayoutServiceFactory.getService();
272 
273         return layoutService.updateLayout(groupId, privateLayout, layoutId,
274             parentLayoutId, localeNamesMap, localeTitlesMap, description, type,
275             hidden, friendlyURL);
276     }
277 
278     public static com.liferay.portal.model.Layout updateLayout(long groupId,
279         boolean privateLayout, long layoutId, long parentLayoutId,
280         java.util.Map<java.util.Locale, String> localeNamesMap,
281         java.util.Map<java.util.Locale, String> localeTitlesMap,
282         java.lang.String description, java.lang.String type, boolean hidden,
283         java.lang.String friendlyURL, java.lang.Boolean iconImage,
284         byte[] iconBytes)
285         throws com.liferay.portal.PortalException,
286             com.liferay.portal.SystemException, java.rmi.RemoteException {
287         LayoutService layoutService = LayoutServiceFactory.getService();
288 
289         return layoutService.updateLayout(groupId, privateLayout, layoutId,
290             parentLayoutId, localeNamesMap, localeTitlesMap, description, type,
291             hidden, friendlyURL, iconImage, iconBytes);
292     }
293 
294     public static com.liferay.portal.model.Layout updateLayout(long groupId,
295         boolean privateLayout, long layoutId, java.lang.String typeSettings)
296         throws com.liferay.portal.PortalException,
297             com.liferay.portal.SystemException, java.rmi.RemoteException {
298         LayoutService layoutService = LayoutServiceFactory.getService();
299 
300         return layoutService.updateLayout(groupId, privateLayout, layoutId,
301             typeSettings);
302     }
303 
304     public static com.liferay.portal.model.Layout updateLookAndFeel(
305         long groupId, boolean privateLayout, long layoutId,
306         java.lang.String themeId, java.lang.String colorSchemeId,
307         java.lang.String css, boolean wapTheme)
308         throws com.liferay.portal.PortalException,
309             com.liferay.portal.SystemException, java.rmi.RemoteException {
310         LayoutService layoutService = LayoutServiceFactory.getService();
311 
312         return layoutService.updateLookAndFeel(groupId, privateLayout,
313             layoutId, themeId, colorSchemeId, css, wapTheme);
314     }
315 
316     public static com.liferay.portal.model.Layout updateName(long plid,
317         java.lang.String name, java.lang.String languageId)
318         throws com.liferay.portal.PortalException,
319             com.liferay.portal.SystemException, java.rmi.RemoteException {
320         LayoutService layoutService = LayoutServiceFactory.getService();
321 
322         return layoutService.updateName(plid, name, languageId);
323     }
324 
325     public static com.liferay.portal.model.Layout updateName(long groupId,
326         boolean privateLayout, long layoutId, java.lang.String name,
327         java.lang.String languageId)
328         throws com.liferay.portal.PortalException,
329             com.liferay.portal.SystemException, java.rmi.RemoteException {
330         LayoutService layoutService = LayoutServiceFactory.getService();
331 
332         return layoutService.updateName(groupId, privateLayout, layoutId, name,
333             languageId);
334     }
335 
336     public static com.liferay.portal.model.Layout updateParentLayoutId(
337         long plid, long parentPlid)
338         throws com.liferay.portal.PortalException,
339             com.liferay.portal.SystemException, java.rmi.RemoteException {
340         LayoutService layoutService = LayoutServiceFactory.getService();
341 
342         return layoutService.updateParentLayoutId(plid, parentPlid);
343     }
344 
345     public static com.liferay.portal.model.Layout updateParentLayoutId(
346         long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
347         throws com.liferay.portal.PortalException,
348             com.liferay.portal.SystemException, java.rmi.RemoteException {
349         LayoutService layoutService = LayoutServiceFactory.getService();
350 
351         return layoutService.updateParentLayoutId(groupId, privateLayout,
352             layoutId, parentLayoutId);
353     }
354 
355     public static com.liferay.portal.model.Layout updatePriority(long plid,
356         int priority)
357         throws com.liferay.portal.PortalException,
358             com.liferay.portal.SystemException, java.rmi.RemoteException {
359         LayoutService layoutService = LayoutServiceFactory.getService();
360 
361         return layoutService.updatePriority(plid, priority);
362     }
363 
364     public static com.liferay.portal.model.Layout updatePriority(long groupId,
365         boolean privateLayout, long layoutId, int priority)
366         throws com.liferay.portal.PortalException,
367             com.liferay.portal.SystemException, java.rmi.RemoteException {
368         LayoutService layoutService = LayoutServiceFactory.getService();
369 
370         return layoutService.updatePriority(groupId, privateLayout, layoutId,
371             priority);
372     }
373 }