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.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. 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.
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. 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.
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. 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.
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            * Returns the Spring bean ID for this bean.
239            *
240            * @return the Spring bean ID for this bean
241            */
242            public static java.lang.String getBeanIdentifier() {
243                    return getService().getBeanIdentifier();
244            }
245    
246            /**
247            * Sets the Spring bean ID for this bean.
248            *
249            * @param beanIdentifier the Spring bean ID for this bean
250            */
251            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
252                    getService().setBeanIdentifier(beanIdentifier);
253            }
254    
255            public static com.liferay.portal.model.LayoutSet addLayoutSet(
256                    long groupId, boolean privateLayout)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException {
259                    return getService().addLayoutSet(groupId, privateLayout);
260            }
261    
262            public static void deleteLayoutSet(long groupId, boolean privateLayout,
263                    com.liferay.portal.service.ServiceContext serviceContext)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException {
266                    getService().deleteLayoutSet(groupId, privateLayout, serviceContext);
267            }
268    
269            public static com.liferay.portal.model.LayoutSet fetchLayoutSet(
270                    java.lang.String virtualHostname)
271                    throws com.liferay.portal.kernel.exception.SystemException {
272                    return getService().fetchLayoutSet(virtualHostname);
273            }
274    
275            public static com.liferay.portal.model.LayoutSet getLayoutSet(
276                    long groupId, boolean privateLayout)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService().getLayoutSet(groupId, privateLayout);
280            }
281    
282            public static com.liferay.portal.model.LayoutSet getLayoutSet(
283                    java.lang.String virtualHostname)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    return getService().getLayoutSet(virtualHostname);
287            }
288    
289            public static java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(
290                    java.lang.String layoutSetPrototypeUuid)
291                    throws com.liferay.portal.kernel.exception.SystemException {
292                    return getService()
293                                       .getLayoutSetsByLayoutSetPrototypeUuid(layoutSetPrototypeUuid);
294            }
295    
296            /**
297            * Updates the state of the layout set prototype link.
298            *
299            * <p>
300            * This method can disable the layout set prototype's link by setting
301            * <code>layoutSetPrototypeLinkEnabled</code> to <code>false</code>.
302            * However, this method can only enable the layout set prototype's link if
303            * the layout set prototype's current uuid is not <code>null</code>. Setting
304            * the <code>layoutSetPrototypeLinkEnabled</code> to <code>true</code> when
305            * the layout set prototype's current uuid is <code>null</code> will have no
306            * effect.
307            * </p>
308            *
309            * @param groupId the primary key of the group
310            * @param privateLayout whether the layout set is private to the group
311            * @param layoutSetPrototypeLinkEnabled whether the layout set
312            prototype is link enabled
313            * @throws PortalException if a portal exception occurred
314            * @throws SystemException if a system exception occurred
315            * @deprecated As of 6.1, replaced by {@link
316            #updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
317            String)}
318            */
319            public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
320                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled)
321                    throws com.liferay.portal.kernel.exception.PortalException,
322                            com.liferay.portal.kernel.exception.SystemException {
323                    getService()
324                            .updateLayoutSetPrototypeLinkEnabled(groupId, privateLayout,
325                            layoutSetPrototypeLinkEnabled);
326            }
327    
328            /**
329            * Updates the state of the layout set prototype link.
330            *
331            * @param groupId the primary key of the group
332            * @param privateLayout whether the layout set is private to the group
333            * @param layoutSetPrototypeLinkEnabled whether the layout set prototype is
334            link enabled
335            * @param layoutSetPrototypeUuid the uuid of the layout set prototype to
336            link with
337            * @throws PortalException if a portal exception occurred
338            * @throws SystemException if a system exception occurred
339            */
340            public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
341                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled,
342                    java.lang.String layoutSetPrototypeUuid)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException {
345                    getService()
346                            .updateLayoutSetPrototypeLinkEnabled(groupId, privateLayout,
347                            layoutSetPrototypeLinkEnabled, layoutSetPrototypeUuid);
348            }
349    
350            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
351                    boolean privateLayout, boolean logo, byte[] bytes)
352                    throws com.liferay.portal.kernel.exception.PortalException,
353                            com.liferay.portal.kernel.exception.SystemException {
354                    return getService().updateLogo(groupId, privateLayout, logo, bytes);
355            }
356    
357            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
358                    boolean privateLayout, boolean logo, java.io.File file)
359                    throws com.liferay.portal.kernel.exception.PortalException,
360                            com.liferay.portal.kernel.exception.SystemException {
361                    return getService().updateLogo(groupId, privateLayout, logo, file);
362            }
363    
364            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
365                    boolean privateLayout, boolean logo, java.io.InputStream is)
366                    throws com.liferay.portal.kernel.exception.PortalException,
367                            com.liferay.portal.kernel.exception.SystemException {
368                    return getService().updateLogo(groupId, privateLayout, logo, is);
369            }
370    
371            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
372                    boolean privateLayout, boolean logo, java.io.InputStream is,
373                    boolean cleanUpStream)
374                    throws com.liferay.portal.kernel.exception.PortalException,
375                            com.liferay.portal.kernel.exception.SystemException {
376                    return getService()
377                                       .updateLogo(groupId, privateLayout, logo, is, cleanUpStream);
378            }
379    
380            public static com.liferay.portal.model.LayoutSet updateLookAndFeel(
381                    long groupId, boolean privateLayout, java.lang.String themeId,
382                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
383                    throws com.liferay.portal.kernel.exception.PortalException,
384                            com.liferay.portal.kernel.exception.SystemException {
385                    return getService()
386                                       .updateLookAndFeel(groupId, privateLayout, themeId,
387                            colorSchemeId, css, wapTheme);
388            }
389    
390            public static void updateLookAndFeel(long groupId,
391                    java.lang.String themeId, java.lang.String colorSchemeId,
392                    java.lang.String css, boolean wapTheme)
393                    throws com.liferay.portal.kernel.exception.PortalException,
394                            com.liferay.portal.kernel.exception.SystemException {
395                    getService()
396                            .updateLookAndFeel(groupId, themeId, colorSchemeId, css, wapTheme);
397            }
398    
399            public static com.liferay.portal.model.LayoutSet updatePageCount(
400                    long groupId, boolean privateLayout)
401                    throws com.liferay.portal.kernel.exception.PortalException,
402                            com.liferay.portal.kernel.exception.SystemException {
403                    return getService().updatePageCount(groupId, privateLayout);
404            }
405    
406            public static com.liferay.portal.model.LayoutSet updateSettings(
407                    long groupId, boolean privateLayout, java.lang.String settings)
408                    throws com.liferay.portal.kernel.exception.PortalException,
409                            com.liferay.portal.kernel.exception.SystemException {
410                    return getService().updateSettings(groupId, privateLayout, settings);
411            }
412    
413            public static com.liferay.portal.model.LayoutSet updateVirtualHost(
414                    long groupId, boolean privateLayout, java.lang.String virtualHostname)
415                    throws com.liferay.portal.kernel.exception.PortalException,
416                            com.liferay.portal.kernel.exception.SystemException {
417                    return getService()
418                                       .updateVirtualHost(groupId, privateLayout, virtualHostname);
419            }
420    
421            public static LayoutSetLocalService getService() {
422                    if (_service == null) {
423                            _service = (LayoutSetLocalService)PortalBeanLocatorUtil.locate(LayoutSetLocalService.class.getName());
424    
425                            ReferenceRegistry.registerReference(LayoutSetLocalServiceUtil.class,
426                                    "_service");
427                    }
428    
429                    return _service;
430            }
431    
432            /**
433             * @deprecated
434             */
435            public void setService(LayoutSetLocalService service) {
436            }
437    
438            private static LayoutSetLocalService _service;
439    }