001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the layout remote service. This utility wraps {@link com.liferay.portal.service.impl.LayoutServiceImpl} and is the primary access point for service operations in application layer code running on a remote server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see LayoutService
032     * @see com.liferay.portal.service.base.LayoutServiceBaseImpl
033     * @see com.liferay.portal.service.impl.LayoutServiceImpl
034     * @generated
035     */
036    public class LayoutServiceUtil {
037            public static com.liferay.portal.model.Layout addLayout(long groupId,
038                    boolean privateLayout, long parentLayoutId,
039                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
040                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
041                    java.lang.String description, java.lang.String type, boolean hidden,
042                    java.lang.String friendlyURL,
043                    com.liferay.portal.service.ServiceContext serviceContext)
044                    throws com.liferay.portal.kernel.exception.PortalException,
045                            com.liferay.portal.kernel.exception.SystemException {
046                    return getService()
047                                       .addLayout(groupId, privateLayout, parentLayoutId,
048                            localeNamesMap, localeTitlesMap, description, type, hidden,
049                            friendlyURL, serviceContext);
050            }
051    
052            public static com.liferay.portal.model.Layout addLayout(long groupId,
053                    boolean privateLayout, long parentLayoutId, java.lang.String name,
054                    java.lang.String title, java.lang.String description,
055                    java.lang.String type, boolean hidden, java.lang.String friendlyURL,
056                    com.liferay.portal.service.ServiceContext serviceContext)
057                    throws com.liferay.portal.kernel.exception.PortalException,
058                            com.liferay.portal.kernel.exception.SystemException {
059                    return getService()
060                                       .addLayout(groupId, privateLayout, parentLayoutId, name,
061                            title, description, type, hidden, friendlyURL, serviceContext);
062            }
063    
064            public static void deleteLayout(long plid)
065                    throws com.liferay.portal.kernel.exception.PortalException,
066                            com.liferay.portal.kernel.exception.SystemException {
067                    getService().deleteLayout(plid);
068            }
069    
070            public static void deleteLayout(long groupId, boolean privateLayout,
071                    long layoutId)
072                    throws com.liferay.portal.kernel.exception.PortalException,
073                            com.liferay.portal.kernel.exception.SystemException {
074                    getService().deleteLayout(groupId, privateLayout, layoutId);
075            }
076    
077            public static byte[] exportLayouts(long groupId, boolean privateLayout,
078                    long[] layoutIds,
079                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
080                    java.util.Date startDate, java.util.Date endDate)
081                    throws com.liferay.portal.kernel.exception.PortalException,
082                            com.liferay.portal.kernel.exception.SystemException {
083                    return getService()
084                                       .exportLayouts(groupId, privateLayout, layoutIds,
085                            parameterMap, startDate, endDate);
086            }
087    
088            public static byte[] exportLayouts(long groupId, boolean privateLayout,
089                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
090                    java.util.Date startDate, java.util.Date endDate)
091                    throws com.liferay.portal.kernel.exception.PortalException,
092                            com.liferay.portal.kernel.exception.SystemException {
093                    return getService()
094                                       .exportLayouts(groupId, privateLayout, parameterMap,
095                            startDate, endDate);
096            }
097    
098            public static java.io.File exportLayoutsAsFile(long groupId,
099                    boolean privateLayout, long[] layoutIds,
100                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
101                    java.util.Date startDate, java.util.Date endDate)
102                    throws com.liferay.portal.kernel.exception.PortalException,
103                            com.liferay.portal.kernel.exception.SystemException {
104                    return getService()
105                                       .exportLayoutsAsFile(groupId, privateLayout, layoutIds,
106                            parameterMap, startDate, endDate);
107            }
108    
109            public static byte[] exportPortletInfo(long plid, long groupId,
110                    java.lang.String portletId,
111                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
112                    java.util.Date startDate, java.util.Date endDate)
113                    throws com.liferay.portal.kernel.exception.PortalException,
114                            com.liferay.portal.kernel.exception.SystemException {
115                    return getService()
116                                       .exportPortletInfo(plid, groupId, portletId, parameterMap,
117                            startDate, endDate);
118            }
119    
120            public static java.io.File exportPortletInfoAsFile(long plid, long groupId,
121                    java.lang.String portletId,
122                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
123                    java.util.Date startDate, java.util.Date endDate)
124                    throws com.liferay.portal.kernel.exception.PortalException,
125                            com.liferay.portal.kernel.exception.SystemException {
126                    return getService()
127                                       .exportPortletInfoAsFile(plid, groupId, portletId,
128                            parameterMap, startDate, endDate);
129            }
130    
131            public static java.lang.String getLayoutName(long groupId,
132                    boolean privateLayout, long layoutId, java.lang.String languageId)
133                    throws com.liferay.portal.kernel.exception.PortalException,
134                            com.liferay.portal.kernel.exception.SystemException {
135                    return getService()
136                                       .getLayoutName(groupId, privateLayout, layoutId, languageId);
137            }
138    
139            public static com.liferay.portal.model.LayoutReference[] getLayoutReferences(
140                    long companyId, java.lang.String portletId,
141                    java.lang.String preferencesKey, java.lang.String preferencesValue)
142                    throws com.liferay.portal.kernel.exception.SystemException {
143                    return getService()
144                                       .getLayoutReferences(companyId, portletId, preferencesKey,
145                            preferencesValue);
146            }
147    
148            public static void importLayouts(long groupId, boolean privateLayout,
149                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
150                    byte[] bytes)
151                    throws com.liferay.portal.kernel.exception.PortalException,
152                            com.liferay.portal.kernel.exception.SystemException {
153                    getService().importLayouts(groupId, privateLayout, parameterMap, bytes);
154            }
155    
156            public static void importLayouts(long groupId, boolean privateLayout,
157                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
158                    java.io.File file)
159                    throws com.liferay.portal.kernel.exception.PortalException,
160                            com.liferay.portal.kernel.exception.SystemException {
161                    getService().importLayouts(groupId, privateLayout, parameterMap, file);
162            }
163    
164            public static void importLayouts(long groupId, boolean privateLayout,
165                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
166                    java.io.InputStream is)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    getService().importLayouts(groupId, privateLayout, parameterMap, is);
170            }
171    
172            public static void importPortletInfo(long plid, long groupId,
173                    java.lang.String portletId,
174                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
175                    java.io.File file)
176                    throws com.liferay.portal.kernel.exception.PortalException,
177                            com.liferay.portal.kernel.exception.SystemException {
178                    getService()
179                            .importPortletInfo(plid, groupId, portletId, parameterMap, file);
180            }
181    
182            public static void importPortletInfo(long plid, long groupId,
183                    java.lang.String portletId,
184                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
185                    java.io.InputStream is)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException {
188                    getService()
189                            .importPortletInfo(plid, groupId, portletId, parameterMap, is);
190            }
191    
192            public static void schedulePublishToLive(long sourceGroupId,
193                    long targetGroupId, boolean privateLayout,
194                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
195                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
196                    java.lang.String scope, java.util.Date startDate,
197                    java.util.Date endDate, java.lang.String groupName,
198                    java.lang.String cronText, java.util.Date schedulerStartDate,
199                    java.util.Date schedulerEndDate, java.lang.String description)
200                    throws com.liferay.portal.kernel.exception.PortalException,
201                            com.liferay.portal.kernel.exception.SystemException {
202                    getService()
203                            .schedulePublishToLive(sourceGroupId, targetGroupId, privateLayout,
204                            layoutIdMap, parameterMap, scope, startDate, endDate, groupName,
205                            cronText, schedulerStartDate, schedulerEndDate, description);
206            }
207    
208            public static void schedulePublishToRemote(long sourceGroupId,
209                    boolean privateLayout,
210                    java.util.Map<java.lang.Long, java.lang.Boolean> layoutIdMap,
211                    java.util.Map<java.lang.String, java.lang.String[]> parameterMap,
212                    java.lang.String remoteAddress, int remotePort,
213                    boolean secureConnection, long remoteGroupId,
214                    boolean remotePrivateLayout, java.util.Date startDate,
215                    java.util.Date endDate, java.lang.String groupName,
216                    java.lang.String cronText, java.util.Date schedulerStartDate,
217                    java.util.Date schedulerEndDate, java.lang.String description)
218                    throws com.liferay.portal.kernel.exception.PortalException,
219                            com.liferay.portal.kernel.exception.SystemException {
220                    getService()
221                            .schedulePublishToRemote(sourceGroupId, privateLayout, layoutIdMap,
222                            parameterMap, remoteAddress, remotePort, secureConnection,
223                            remoteGroupId, remotePrivateLayout, startDate, endDate, groupName,
224                            cronText, schedulerStartDate, schedulerEndDate, description);
225            }
226    
227            public static void setLayouts(long groupId, boolean privateLayout,
228                    long parentLayoutId, long[] layoutIds)
229                    throws com.liferay.portal.kernel.exception.PortalException,
230                            com.liferay.portal.kernel.exception.SystemException {
231                    getService()
232                            .setLayouts(groupId, privateLayout, parentLayoutId, layoutIds);
233            }
234    
235            public static void unschedulePublishToLive(long groupId,
236                    java.lang.String jobName, java.lang.String groupName)
237                    throws com.liferay.portal.kernel.exception.PortalException,
238                            com.liferay.portal.kernel.exception.SystemException {
239                    getService().unschedulePublishToLive(groupId, jobName, groupName);
240            }
241    
242            public static void unschedulePublishToRemote(long groupId,
243                    java.lang.String jobName, java.lang.String groupName)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException {
246                    getService().unschedulePublishToRemote(groupId, jobName, groupName);
247            }
248    
249            public static com.liferay.portal.model.Layout updateLayout(long groupId,
250                    boolean privateLayout, long layoutId, long parentLayoutId,
251                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
252                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
253                    java.lang.String description, java.lang.String type, boolean hidden,
254                    java.lang.String friendlyURL, java.lang.Boolean iconImage,
255                    byte[] iconBytes,
256                    com.liferay.portal.service.ServiceContext serviceContext)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException {
259                    return getService()
260                                       .updateLayout(groupId, privateLayout, layoutId,
261                            parentLayoutId, localeNamesMap, localeTitlesMap, description, type,
262                            hidden, friendlyURL, iconImage, iconBytes, serviceContext);
263            }
264    
265            public static com.liferay.portal.model.Layout updateLayout(long groupId,
266                    boolean privateLayout, long layoutId, long parentLayoutId,
267                    java.util.Map<java.util.Locale, java.lang.String> localeNamesMap,
268                    java.util.Map<java.util.Locale, java.lang.String> localeTitlesMap,
269                    java.lang.String description, java.lang.String type, boolean hidden,
270                    java.lang.String friendlyURL,
271                    com.liferay.portal.service.ServiceContext serviceContext)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    return getService()
275                                       .updateLayout(groupId, privateLayout, layoutId,
276                            parentLayoutId, localeNamesMap, localeTitlesMap, description, type,
277                            hidden, friendlyURL, serviceContext);
278            }
279    
280            public static com.liferay.portal.model.Layout updateLayout(long groupId,
281                    boolean privateLayout, long layoutId, java.lang.String typeSettings)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    return getService()
285                                       .updateLayout(groupId, privateLayout, layoutId, typeSettings);
286            }
287    
288            public static com.liferay.portal.model.Layout updateLookAndFeel(
289                    long groupId, boolean privateLayout, long layoutId,
290                    java.lang.String themeId, java.lang.String colorSchemeId,
291                    java.lang.String css, boolean wapTheme)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    return getService()
295                                       .updateLookAndFeel(groupId, privateLayout, layoutId,
296                            themeId, colorSchemeId, css, wapTheme);
297            }
298    
299            public static com.liferay.portal.model.Layout updateName(long groupId,
300                    boolean privateLayout, long layoutId, java.lang.String name,
301                    java.lang.String languageId)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService()
305                                       .updateName(groupId, privateLayout, layoutId, name,
306                            languageId);
307            }
308    
309            public static com.liferay.portal.model.Layout updateName(long plid,
310                    java.lang.String name, java.lang.String languageId)
311                    throws com.liferay.portal.kernel.exception.PortalException,
312                            com.liferay.portal.kernel.exception.SystemException {
313                    return getService().updateName(plid, name, languageId);
314            }
315    
316            public static com.liferay.portal.model.Layout updateParentLayoutId(
317                    long groupId, boolean privateLayout, long layoutId, long parentLayoutId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    return getService()
321                                       .updateParentLayoutId(groupId, privateLayout, layoutId,
322                            parentLayoutId);
323            }
324    
325            public static com.liferay.portal.model.Layout updateParentLayoutId(
326                    long plid, long parentPlid)
327                    throws com.liferay.portal.kernel.exception.PortalException,
328                            com.liferay.portal.kernel.exception.SystemException {
329                    return getService().updateParentLayoutId(plid, parentPlid);
330            }
331    
332            public static com.liferay.portal.model.Layout updatePriority(long groupId,
333                    boolean privateLayout, long layoutId, int priority)
334                    throws com.liferay.portal.kernel.exception.PortalException,
335                            com.liferay.portal.kernel.exception.SystemException {
336                    return getService()
337                                       .updatePriority(groupId, privateLayout, layoutId, priority);
338            }
339    
340            public static com.liferay.portal.model.Layout updatePriority(long plid,
341                    int priority)
342                    throws com.liferay.portal.kernel.exception.PortalException,
343                            com.liferay.portal.kernel.exception.SystemException {
344                    return getService().updatePriority(plid, priority);
345            }
346    
347            public static LayoutService getService() {
348                    if (_service == null) {
349                            _service = (LayoutService)PortalBeanLocatorUtil.locate(LayoutService.class.getName());
350                    }
351    
352                    return _service;
353            }
354    
355            public void setService(LayoutService service) {
356                    _service = service;
357            }
358    
359            private static LayoutService _service;
360    }