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