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