001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the layout set local service. This utility wraps {@link com.liferay.portal.service.impl.LayoutSetLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see LayoutSetLocalService
030     * @see com.liferay.portal.service.base.LayoutSetLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.LayoutSetLocalServiceImpl
032     * @generated
033     */
034    public class LayoutSetLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the layout set to the database. Also notifies the appropriate model listeners.
043            *
044            * @param layoutSet the layout set
045            * @return the layout set that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.LayoutSet addLayoutSet(
049                    com.liferay.portal.model.LayoutSet layoutSet)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addLayoutSet(layoutSet);
052            }
053    
054            /**
055            * Creates a new layout set with the primary key. Does not add the layout set to the database.
056            *
057            * @param layoutSetId the primary key for the new layout set
058            * @return the new layout set
059            */
060            public static com.liferay.portal.model.LayoutSet createLayoutSet(
061                    long layoutSetId) {
062                    return getService().createLayoutSet(layoutSetId);
063            }
064    
065            /**
066            * Deletes the layout set with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param layoutSetId the primary key of the layout set
069            * @throws PortalException if a layout set with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteLayoutSet(long layoutSetId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteLayoutSet(layoutSetId);
076            }
077    
078            /**
079            * Deletes the layout set from the database. Also notifies the appropriate model listeners.
080            *
081            * @param layoutSet the layout set
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteLayoutSet(
085                    com.liferay.portal.model.LayoutSet layoutSet)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteLayoutSet(layoutSet);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            public static com.liferay.portal.model.LayoutSet fetchLayoutSet(
162                    long layoutSetId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchLayoutSet(layoutSetId);
165            }
166    
167            /**
168            * Returns the layout set with the primary key.
169            *
170            * @param layoutSetId the primary key of the layout set
171            * @return the layout set
172            * @throws PortalException if a layout set with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portal.model.LayoutSet getLayoutSet(
176                    long layoutSetId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getLayoutSet(layoutSetId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the layout sets.
191            *
192            * <p>
193            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
194            * </p>
195            *
196            * @param start the lower bound of the range of layout sets
197            * @param end the upper bound of the range of layout sets (not inclusive)
198            * @return the range of layout sets
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSets(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getLayoutSets(start, end);
205            }
206    
207            /**
208            * Returns the number of layout sets.
209            *
210            * @return the number of layout sets
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getLayoutSetsCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getLayoutSetsCount();
216            }
217    
218            /**
219            * Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param layoutSet the layout set
222            * @return the layout set that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portal.model.LayoutSet updateLayoutSet(
226                    com.liferay.portal.model.LayoutSet layoutSet)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updateLayoutSet(layoutSet);
229            }
230    
231            /**
232            * Updates the layout set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param layoutSet the layout set
235            * @param merge whether to merge the layout set with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
236            * @return the layout set that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portal.model.LayoutSet updateLayoutSet(
240                    com.liferay.portal.model.LayoutSet layoutSet, boolean merge)
241                    throws com.liferay.portal.kernel.exception.SystemException {
242                    return getService().updateLayoutSet(layoutSet, merge);
243            }
244    
245            /**
246            * Returns the Spring bean ID for this bean.
247            *
248            * @return the Spring bean ID for this bean
249            */
250            public static java.lang.String getBeanIdentifier() {
251                    return getService().getBeanIdentifier();
252            }
253    
254            /**
255            * Sets the Spring bean ID for this bean.
256            *
257            * @param beanIdentifier the Spring bean ID for this bean
258            */
259            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
260                    getService().setBeanIdentifier(beanIdentifier);
261            }
262    
263            public static com.liferay.portal.model.LayoutSet addLayoutSet(
264                    long groupId, boolean privateLayout)
265                    throws com.liferay.portal.kernel.exception.PortalException,
266                            com.liferay.portal.kernel.exception.SystemException {
267                    return getService().addLayoutSet(groupId, privateLayout);
268            }
269    
270            public static void deleteLayoutSet(long groupId, boolean privateLayout,
271                    com.liferay.portal.service.ServiceContext serviceContext)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    getService().deleteLayoutSet(groupId, privateLayout, serviceContext);
275            }
276    
277            public static com.liferay.portal.model.LayoutSet fetchLayoutSet(
278                    java.lang.String virtualHostname)
279                    throws com.liferay.portal.kernel.exception.SystemException {
280                    return getService().fetchLayoutSet(virtualHostname);
281            }
282    
283            public static com.liferay.portal.model.LayoutSet getLayoutSet(
284                    long groupId, boolean privateLayout)
285                    throws com.liferay.portal.kernel.exception.PortalException,
286                            com.liferay.portal.kernel.exception.SystemException {
287                    return getService().getLayoutSet(groupId, privateLayout);
288            }
289    
290            public static com.liferay.portal.model.LayoutSet getLayoutSet(
291                    java.lang.String virtualHostname)
292                    throws com.liferay.portal.kernel.exception.PortalException,
293                            com.liferay.portal.kernel.exception.SystemException {
294                    return getService().getLayoutSet(virtualHostname);
295            }
296    
297            public static java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(
298                    java.lang.String layoutSetPrototypeUuid)
299                    throws com.liferay.portal.kernel.exception.SystemException {
300                    return getService()
301                                       .getLayoutSetsByLayoutSetPrototypeUuid(layoutSetPrototypeUuid);
302            }
303    
304            /**
305            * Updates the state of the layout set prototype link.
306            *
307            * <p>
308            * This method can disable the layout set prototype's link by setting
309            * <code>layoutSetPrototypeLinkEnabled</code> to <code>false</code>.
310            * However, this method can only enable the layout set prototype's link if
311            * the layout set prototype's current uuid is not <code>null</code>. Setting
312            * the <code>layoutSetPrototypeLinkEnabled</code> to <code>true</code> when
313            * the layout set prototype's current uuid is <code>null</code> will have no
314            * effect.
315            * </p>
316            *
317            * @param groupId the primary key of the group
318            * @param privateLayout whether the layout set is private to the group
319            * @param layoutSetPrototypeLinkEnabled whether the layout set
320            prototype is link enabled
321            * @throws PortalException if a portal exception occurred
322            * @throws SystemException if a system exception occurred
323            * @deprecated As of 6.1, replaced by {@link
324            #updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
325            String)}
326            */
327            public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
328                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled)
329                    throws com.liferay.portal.kernel.exception.PortalException,
330                            com.liferay.portal.kernel.exception.SystemException {
331                    getService()
332                            .updateLayoutSetPrototypeLinkEnabled(groupId, privateLayout,
333                            layoutSetPrototypeLinkEnabled);
334            }
335    
336            /**
337            * Updates the state of the layout set prototype link.
338            *
339            * @param groupId the primary key of the group
340            * @param privateLayout whether the layout set is private to the group
341            * @param layoutSetPrototypeLinkEnabled whether the layout set prototype is
342            link enabled
343            * @param layoutSetPrototypeUuid the uuid of the layout set prototype to
344            link with
345            * @throws PortalException if a portal exception occurred
346            * @throws SystemException if a system exception occurred
347            */
348            public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
349                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled,
350                    java.lang.String layoutSetPrototypeUuid)
351                    throws com.liferay.portal.kernel.exception.PortalException,
352                            com.liferay.portal.kernel.exception.SystemException {
353                    getService()
354                            .updateLayoutSetPrototypeLinkEnabled(groupId, privateLayout,
355                            layoutSetPrototypeLinkEnabled, layoutSetPrototypeUuid);
356            }
357    
358            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
359                    boolean privateLayout, boolean logo, java.io.File file)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService().updateLogo(groupId, privateLayout, logo, file);
363            }
364    
365            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
366                    boolean privateLayout, boolean logo, java.io.InputStream is)
367                    throws com.liferay.portal.kernel.exception.PortalException,
368                            com.liferay.portal.kernel.exception.SystemException {
369                    return getService().updateLogo(groupId, privateLayout, logo, is);
370            }
371    
372            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
373                    boolean privateLayout, boolean logo, java.io.InputStream is,
374                    boolean cleanUpStream)
375                    throws com.liferay.portal.kernel.exception.PortalException,
376                            com.liferay.portal.kernel.exception.SystemException {
377                    return getService()
378                                       .updateLogo(groupId, privateLayout, logo, is, cleanUpStream);
379            }
380    
381            public static com.liferay.portal.model.LayoutSet updateLookAndFeel(
382                    long groupId, boolean privateLayout, java.lang.String themeId,
383                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
384                    throws com.liferay.portal.kernel.exception.PortalException,
385                            com.liferay.portal.kernel.exception.SystemException {
386                    return getService()
387                                       .updateLookAndFeel(groupId, privateLayout, themeId,
388                            colorSchemeId, css, wapTheme);
389            }
390    
391            public static void updateLookAndFeel(long groupId,
392                    java.lang.String themeId, java.lang.String colorSchemeId,
393                    java.lang.String css, boolean wapTheme)
394                    throws com.liferay.portal.kernel.exception.PortalException,
395                            com.liferay.portal.kernel.exception.SystemException {
396                    getService()
397                            .updateLookAndFeel(groupId, themeId, colorSchemeId, css, wapTheme);
398            }
399    
400            public static com.liferay.portal.model.LayoutSet updatePageCount(
401                    long groupId, boolean privateLayout)
402                    throws com.liferay.portal.kernel.exception.PortalException,
403                            com.liferay.portal.kernel.exception.SystemException {
404                    return getService().updatePageCount(groupId, privateLayout);
405            }
406    
407            public static com.liferay.portal.model.LayoutSet updateSettings(
408                    long groupId, boolean privateLayout, java.lang.String settings)
409                    throws com.liferay.portal.kernel.exception.PortalException,
410                            com.liferay.portal.kernel.exception.SystemException {
411                    return getService().updateSettings(groupId, privateLayout, settings);
412            }
413    
414            public static com.liferay.portal.model.LayoutSet updateVirtualHost(
415                    long groupId, boolean privateLayout, java.lang.String virtualHostname)
416                    throws com.liferay.portal.kernel.exception.PortalException,
417                            com.liferay.portal.kernel.exception.SystemException {
418                    return getService()
419                                       .updateVirtualHost(groupId, privateLayout, virtualHostname);
420            }
421    
422            public static LayoutSetLocalService getService() {
423                    if (_service == null) {
424                            _service = (LayoutSetLocalService)PortalBeanLocatorUtil.locate(LayoutSetLocalService.class.getName());
425    
426                            ReferenceRegistry.registerReference(LayoutSetLocalServiceUtil.class,
427                                    "_service");
428                            MethodCache.remove(LayoutSetLocalService.class);
429                    }
430    
431                    return _service;
432            }
433    
434            public void setService(LayoutSetLocalService service) {
435                    MethodCache.remove(LayoutSetLocalService.class);
436    
437                    _service = service;
438    
439                    ReferenceRegistry.registerReference(LayoutSetLocalServiceUtil.class,
440                            "_service");
441                    MethodCache.remove(LayoutSetLocalService.class);
442            }
443    
444            private static LayoutSetLocalService _service;
445    }