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