001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 fetchLayoutSetByLogoId(
295                    boolean privateLayout, long logoId)
296                    throws com.liferay.portal.kernel.exception.SystemException {
297                    return getService().fetchLayoutSetByLogoId(privateLayout, logoId);
298            }
299    
300            public static com.liferay.portal.model.LayoutSet getLayoutSet(
301                    long groupId, boolean privateLayout)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService().getLayoutSet(groupId, privateLayout);
305            }
306    
307            public static com.liferay.portal.model.LayoutSet getLayoutSet(
308                    java.lang.String virtualHostname)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    return getService().getLayoutSet(virtualHostname);
312            }
313    
314            public static java.util.List<com.liferay.portal.model.LayoutSet> getLayoutSetsByLayoutSetPrototypeUuid(
315                    java.lang.String layoutSetPrototypeUuid)
316                    throws com.liferay.portal.kernel.exception.SystemException {
317                    return getService()
318                                       .getLayoutSetsByLayoutSetPrototypeUuid(layoutSetPrototypeUuid);
319            }
320    
321            /**
322            * Updates the state of the layout set prototype link.
323            *
324            * <p>
325            * This method can disable the layout set prototype's link by setting
326            * <code>layoutSetPrototypeLinkEnabled</code> to <code>false</code>.
327            * However, this method can only enable the layout set prototype's link if
328            * the layout set prototype's current uuid is not <code>null</code>. Setting
329            * the <code>layoutSetPrototypeLinkEnabled</code> to <code>true</code> when
330            * the layout set prototype's current uuid is <code>null</code> will have no
331            * effect.
332            * </p>
333            *
334            * @param groupId the primary key of the group
335            * @param privateLayout whether the layout set is private to the group
336            * @param layoutSetPrototypeLinkEnabled whether the layout set
337            prototype is link enabled
338            * @throws PortalException if a portal exception occurred
339            * @throws SystemException if a system exception occurred
340            * @deprecated As of 6.1.0, replaced by {@link
341            #updateLayoutSetPrototypeLinkEnabled(long, boolean, boolean,
342            String)}
343            */
344            public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
345                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled)
346                    throws com.liferay.portal.kernel.exception.PortalException,
347                            com.liferay.portal.kernel.exception.SystemException {
348                    getService()
349                            .updateLayoutSetPrototypeLinkEnabled(groupId, privateLayout,
350                            layoutSetPrototypeLinkEnabled);
351            }
352    
353            /**
354            * Updates the state of the layout set prototype link.
355            *
356            * @param groupId the primary key of the group
357            * @param privateLayout whether the layout set is private to the group
358            * @param layoutSetPrototypeLinkEnabled whether the layout set prototype is
359            link enabled
360            * @param layoutSetPrototypeUuid the uuid of the layout set prototype to
361            link with
362            * @throws PortalException if a portal exception occurred
363            * @throws SystemException if a system exception occurred
364            */
365            public static void updateLayoutSetPrototypeLinkEnabled(long groupId,
366                    boolean privateLayout, boolean layoutSetPrototypeLinkEnabled,
367                    java.lang.String layoutSetPrototypeUuid)
368                    throws com.liferay.portal.kernel.exception.PortalException,
369                            com.liferay.portal.kernel.exception.SystemException {
370                    getService()
371                            .updateLayoutSetPrototypeLinkEnabled(groupId, privateLayout,
372                            layoutSetPrototypeLinkEnabled, layoutSetPrototypeUuid);
373            }
374    
375            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
376                    boolean privateLayout, boolean logo, byte[] bytes)
377                    throws com.liferay.portal.kernel.exception.PortalException,
378                            com.liferay.portal.kernel.exception.SystemException {
379                    return getService().updateLogo(groupId, privateLayout, logo, bytes);
380            }
381    
382            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
383                    boolean privateLayout, boolean logo, java.io.File file)
384                    throws com.liferay.portal.kernel.exception.PortalException,
385                            com.liferay.portal.kernel.exception.SystemException {
386                    return getService().updateLogo(groupId, privateLayout, logo, file);
387            }
388    
389            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
390                    boolean privateLayout, boolean logo, java.io.InputStream is)
391                    throws com.liferay.portal.kernel.exception.PortalException,
392                            com.liferay.portal.kernel.exception.SystemException {
393                    return getService().updateLogo(groupId, privateLayout, logo, is);
394            }
395    
396            public static com.liferay.portal.model.LayoutSet updateLogo(long groupId,
397                    boolean privateLayout, boolean logo, java.io.InputStream is,
398                    boolean cleanUpStream)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    return getService()
402                                       .updateLogo(groupId, privateLayout, logo, is, cleanUpStream);
403            }
404    
405            public static com.liferay.portal.model.LayoutSet updateLookAndFeel(
406                    long groupId, boolean privateLayout, java.lang.String themeId,
407                    java.lang.String colorSchemeId, java.lang.String css, boolean wapTheme)
408                    throws com.liferay.portal.kernel.exception.PortalException,
409                            com.liferay.portal.kernel.exception.SystemException {
410                    return getService()
411                                       .updateLookAndFeel(groupId, privateLayout, themeId,
412                            colorSchemeId, css, wapTheme);
413            }
414    
415            public static void updateLookAndFeel(long groupId,
416                    java.lang.String themeId, java.lang.String colorSchemeId,
417                    java.lang.String css, boolean wapTheme)
418                    throws com.liferay.portal.kernel.exception.PortalException,
419                            com.liferay.portal.kernel.exception.SystemException {
420                    getService()
421                            .updateLookAndFeel(groupId, themeId, colorSchemeId, css, wapTheme);
422            }
423    
424            public static com.liferay.portal.model.LayoutSet updatePageCount(
425                    long groupId, boolean privateLayout)
426                    throws com.liferay.portal.kernel.exception.PortalException,
427                            com.liferay.portal.kernel.exception.SystemException {
428                    return getService().updatePageCount(groupId, privateLayout);
429            }
430    
431            public static com.liferay.portal.model.LayoutSet updateSettings(
432                    long groupId, boolean privateLayout, java.lang.String settings)
433                    throws com.liferay.portal.kernel.exception.PortalException,
434                            com.liferay.portal.kernel.exception.SystemException {
435                    return getService().updateSettings(groupId, privateLayout, settings);
436            }
437    
438            public static com.liferay.portal.model.LayoutSet updateVirtualHost(
439                    long groupId, boolean privateLayout, java.lang.String virtualHostname)
440                    throws com.liferay.portal.kernel.exception.PortalException,
441                            com.liferay.portal.kernel.exception.SystemException {
442                    return getService()
443                                       .updateVirtualHost(groupId, privateLayout, virtualHostname);
444            }
445    
446            public static LayoutSetLocalService getService() {
447                    if (_service == null) {
448                            _service = (LayoutSetLocalService)PortalBeanLocatorUtil.locate(LayoutSetLocalService.class.getName());
449    
450                            ReferenceRegistry.registerReference(LayoutSetLocalServiceUtil.class,
451                                    "_service");
452                    }
453    
454                    return _service;
455            }
456    
457            /**
458             * @deprecated As of 6.2.0
459             */
460            public void setService(LayoutSetLocalService service) {
461            }
462    
463            private static LayoutSetLocalService _service;
464    }