001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the layout revision local service. This utility wraps {@link com.liferay.portal.service.impl.LayoutRevisionLocalServiceImpl} 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 LayoutRevisionLocalService
029     * @see com.liferay.portal.service.base.LayoutRevisionLocalServiceBaseImpl
030     * @see com.liferay.portal.service.impl.LayoutRevisionLocalServiceImpl
031     * @generated
032     */
033    public class LayoutRevisionLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutRevisionLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the layout revision to the database. Also notifies the appropriate model listeners.
042            *
043            * @param layoutRevision the layout revision
044            * @return the layout revision that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portal.model.LayoutRevision addLayoutRevision(
048                    com.liferay.portal.model.LayoutRevision layoutRevision)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addLayoutRevision(layoutRevision);
051            }
052    
053            /**
054            * Creates a new layout revision with the primary key. Does not add the layout revision to the database.
055            *
056            * @param layoutRevisionId the primary key for the new layout revision
057            * @return the new layout revision
058            */
059            public static com.liferay.portal.model.LayoutRevision createLayoutRevision(
060                    long layoutRevisionId) {
061                    return getService().createLayoutRevision(layoutRevisionId);
062            }
063    
064            /**
065            * Deletes the layout revision with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param layoutRevisionId the primary key of the layout revision
068            * @return the layout revision that was removed
069            * @throws PortalException if a layout revision with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static com.liferay.portal.model.LayoutRevision deleteLayoutRevision(
073                    long layoutRevisionId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteLayoutRevision(layoutRevisionId);
077            }
078    
079            /**
080            * Deletes the layout revision from the database. Also notifies the appropriate model listeners.
081            *
082            * @param layoutRevision the layout revision
083            * @return the layout revision that was removed
084            * @throws PortalException
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portal.model.LayoutRevision deleteLayoutRevision(
088                    com.liferay.portal.model.LayoutRevision layoutRevision)
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException {
091                    return getService().deleteLayoutRevision(layoutRevision);
092            }
093    
094            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
095                    return getService().dynamicQuery();
096            }
097    
098            /**
099            * Performs a dynamic query on the database and returns the matching rows.
100            *
101            * @param dynamicQuery the dynamic query
102            * @return the matching rows
103            * @throws SystemException if a system exception occurred
104            */
105            @SuppressWarnings("rawtypes")
106            public static java.util.List dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
108                    throws com.liferay.portal.kernel.exception.SystemException {
109                    return getService().dynamicQuery(dynamicQuery);
110            }
111    
112            /**
113            * Performs a dynamic query on the database and returns a range of the matching rows.
114            *
115            * <p>
116            * 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.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query
120            * @param start the lower bound of the range of model instances
121            * @param end the upper bound of the range of model instances (not inclusive)
122            * @return the range of matching rows
123            * @throws SystemException if a system exception occurred
124            */
125            @SuppressWarnings("rawtypes")
126            public static java.util.List dynamicQuery(
127                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
128                    int end) throws com.liferay.portal.kernel.exception.SystemException {
129                    return getService().dynamicQuery(dynamicQuery, start, end);
130            }
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            * @throws SystemException if a system exception occurred
145            */
146            @SuppressWarnings("rawtypes")
147            public static java.util.List dynamicQuery(
148                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
149                    int end,
150                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
151                    throws com.liferay.portal.kernel.exception.SystemException {
152                    return getService()
153                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
154            }
155    
156            /**
157            * Returns the number of rows that match the dynamic query.
158            *
159            * @param dynamicQuery the dynamic query
160            * @return the number of rows that match the dynamic query
161            * @throws SystemException if a system exception occurred
162            */
163            public static long dynamicQueryCount(
164                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
165                    throws com.liferay.portal.kernel.exception.SystemException {
166                    return getService().dynamicQueryCount(dynamicQuery);
167            }
168    
169            public static com.liferay.portal.model.LayoutRevision fetchLayoutRevision(
170                    long layoutRevisionId)
171                    throws com.liferay.portal.kernel.exception.SystemException {
172                    return getService().fetchLayoutRevision(layoutRevisionId);
173            }
174    
175            /**
176            * Returns the layout revision with the primary key.
177            *
178            * @param layoutRevisionId the primary key of the layout revision
179            * @return the layout revision
180            * @throws PortalException if a layout revision with the primary key could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            public static com.liferay.portal.model.LayoutRevision getLayoutRevision(
184                    long layoutRevisionId)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getLayoutRevision(layoutRevisionId);
188            }
189    
190            public static com.liferay.portal.model.PersistedModel getPersistedModel(
191                    java.io.Serializable primaryKeyObj)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException {
194                    return getService().getPersistedModel(primaryKeyObj);
195            }
196    
197            /**
198            * Returns a range of all the layout revisions.
199            *
200            * <p>
201            * 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.
202            * </p>
203            *
204            * @param start the lower bound of the range of layout revisions
205            * @param end the upper bound of the range of layout revisions (not inclusive)
206            * @return the range of layout revisions
207            * @throws SystemException if a system exception occurred
208            */
209            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException {
212                    return getService().getLayoutRevisions(start, end);
213            }
214    
215            /**
216            * Returns the number of layout revisions.
217            *
218            * @return the number of layout revisions
219            * @throws SystemException if a system exception occurred
220            */
221            public static int getLayoutRevisionsCount()
222                    throws com.liferay.portal.kernel.exception.SystemException {
223                    return getService().getLayoutRevisionsCount();
224            }
225    
226            /**
227            * Updates the layout revision in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
228            *
229            * @param layoutRevision the layout revision
230            * @return the layout revision that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portal.model.LayoutRevision updateLayoutRevision(
234                    com.liferay.portal.model.LayoutRevision layoutRevision)
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().updateLayoutRevision(layoutRevision);
237            }
238    
239            /**
240            * Updates the layout revision in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
241            *
242            * @param layoutRevision the layout revision
243            * @param merge whether to merge the layout revision with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
244            * @return the layout revision that was updated
245            * @throws SystemException if a system exception occurred
246            */
247            public static com.liferay.portal.model.LayoutRevision updateLayoutRevision(
248                    com.liferay.portal.model.LayoutRevision layoutRevision, boolean merge)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().updateLayoutRevision(layoutRevision, merge);
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.LayoutRevision addLayoutRevision(
272                    long userId, long layoutSetBranchId, long layoutBranchId,
273                    long parentLayoutRevisionId, boolean head, long plid,
274                    long portletPreferencesPlid, boolean privateLayout,
275                    java.lang.String name, java.lang.String title,
276                    java.lang.String description, java.lang.String keywords,
277                    java.lang.String robots, java.lang.String typeSettings,
278                    boolean iconImage, long iconImageId, java.lang.String themeId,
279                    java.lang.String colorSchemeId, java.lang.String wapThemeId,
280                    java.lang.String wapColorSchemeId, java.lang.String css,
281                    com.liferay.portal.service.ServiceContext serviceContext)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    return getService()
285                                       .addLayoutRevision(userId, layoutSetBranchId,
286                            layoutBranchId, parentLayoutRevisionId, head, plid,
287                            portletPreferencesPlid, privateLayout, name, title, description,
288                            keywords, robots, typeSettings, iconImage, iconImageId, themeId,
289                            colorSchemeId, wapThemeId, wapColorSchemeId, css, serviceContext);
290            }
291    
292            public static void deleteLayoutLayoutRevisions(long plid)
293                    throws com.liferay.portal.kernel.exception.PortalException,
294                            com.liferay.portal.kernel.exception.SystemException {
295                    getService().deleteLayoutLayoutRevisions(plid);
296            }
297    
298            public static void deleteLayoutRevisions(long layoutSetBranchId, long plid)
299                    throws com.liferay.portal.kernel.exception.PortalException,
300                            com.liferay.portal.kernel.exception.SystemException {
301                    getService().deleteLayoutRevisions(layoutSetBranchId, plid);
302            }
303    
304            public static void deleteLayoutRevisions(long layoutSetBranchId,
305                    long layoutBranchId, long plid)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    getService()
309                            .deleteLayoutRevisions(layoutSetBranchId, layoutBranchId, plid);
310            }
311    
312            public static void deleteLayoutSetBranchLayoutRevisions(
313                    long layoutSetBranchId)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    getService().deleteLayoutSetBranchLayoutRevisions(layoutSetBranchId);
317            }
318    
319            public static com.liferay.portal.model.LayoutRevision fetchLastLayoutRevision(
320                    long plid, boolean head)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService().fetchLastLayoutRevision(plid, head);
323            }
324    
325            public static java.util.List<com.liferay.portal.model.LayoutRevision> getChildLayoutRevisions(
326                    long layoutSetBranchId, long parentLayoutRevisionId, long plid)
327                    throws com.liferay.portal.kernel.exception.SystemException {
328                    return getService()
329                                       .getChildLayoutRevisions(layoutSetBranchId,
330                            parentLayoutRevisionId, plid);
331            }
332    
333            public static java.util.List<com.liferay.portal.model.LayoutRevision> getChildLayoutRevisions(
334                    long layoutSetBranchId, long parentLayoutRevision, long plid,
335                    int start, int end,
336                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService()
339                                       .getChildLayoutRevisions(layoutSetBranchId,
340                            parentLayoutRevision, plid, start, end, orderByComparator);
341            }
342    
343            public static int getChildLayoutRevisionsCount(long layoutSetBranchId,
344                    long parentLayoutRevision, long plid)
345                    throws com.liferay.portal.kernel.exception.SystemException {
346                    return getService()
347                                       .getChildLayoutRevisionsCount(layoutSetBranchId,
348                            parentLayoutRevision, plid);
349            }
350    
351            public static com.liferay.portal.model.LayoutRevision getLayoutRevision(
352                    long layoutSetBranchId, long plid, boolean head)
353                    throws com.liferay.portal.kernel.exception.PortalException,
354                            com.liferay.portal.kernel.exception.SystemException {
355                    return getService().getLayoutRevision(layoutSetBranchId, plid, head);
356            }
357    
358            public static com.liferay.portal.model.LayoutRevision getLayoutRevision(
359                    long layoutSetBranchId, long layoutBranchId, long plid)
360                    throws com.liferay.portal.kernel.exception.PortalException,
361                            com.liferay.portal.kernel.exception.SystemException {
362                    return getService()
363                                       .getLayoutRevision(layoutSetBranchId, layoutBranchId, plid);
364            }
365    
366            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
367                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
368                    return getService().getLayoutRevisions(plid);
369            }
370    
371            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
372                    long layoutSetBranchId, boolean head)
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getLayoutRevisions(layoutSetBranchId, head);
375            }
376    
377            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
378                    long layoutSetBranchId, int status)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getLayoutRevisions(layoutSetBranchId, status);
381            }
382    
383            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
384                    long layoutSetBranchId, long plid)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return getService().getLayoutRevisions(layoutSetBranchId, plid);
387            }
388    
389            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
390                    long layoutSetBranchId, long plid, int status)
391                    throws com.liferay.portal.kernel.exception.SystemException {
392                    return getService().getLayoutRevisions(layoutSetBranchId, plid, status);
393            }
394    
395            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
396                    long layoutSetBranchId, long plid, int start, int end,
397                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
398                    throws com.liferay.portal.kernel.exception.SystemException {
399                    return getService()
400                                       .getLayoutRevisions(layoutSetBranchId, plid, start, end,
401                            orderByComparator);
402            }
403    
404            public static java.util.List<com.liferay.portal.model.LayoutRevision> getLayoutRevisions(
405                    long layoutSetBranchId, long layoutBranchId, long plid, int start,
406                    int end,
407                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return getService()
410                                       .getLayoutRevisions(layoutSetBranchId, layoutBranchId, plid,
411                            start, end, orderByComparator);
412            }
413    
414            public static int getLayoutRevisionsCount(long layoutSetBranchId,
415                    long layoutBranchId, long plid)
416                    throws com.liferay.portal.kernel.exception.SystemException {
417                    return getService()
418                                       .getLayoutRevisionsCount(layoutSetBranchId, layoutBranchId,
419                            plid);
420            }
421    
422            public static com.liferay.portal.model.LayoutRevision updateLayoutRevision(
423                    long userId, long layoutRevisionId, long layoutBranchId,
424                    java.lang.String name, java.lang.String title,
425                    java.lang.String description, java.lang.String keywords,
426                    java.lang.String robots, java.lang.String typeSettings,
427                    boolean iconImage, long iconImageId, java.lang.String themeId,
428                    java.lang.String colorSchemeId, java.lang.String wapThemeId,
429                    java.lang.String wapColorSchemeId, java.lang.String css,
430                    com.liferay.portal.service.ServiceContext serviceContext)
431                    throws com.liferay.portal.kernel.exception.PortalException,
432                            com.liferay.portal.kernel.exception.SystemException {
433                    return getService()
434                                       .updateLayoutRevision(userId, layoutRevisionId,
435                            layoutBranchId, name, title, description, keywords, robots,
436                            typeSettings, iconImage, iconImageId, themeId, colorSchemeId,
437                            wapThemeId, wapColorSchemeId, css, serviceContext);
438            }
439    
440            public static com.liferay.portal.model.LayoutRevision updateStatus(
441                    long userId, long layoutRevisionId, int status,
442                    com.liferay.portal.service.ServiceContext serviceContext)
443                    throws com.liferay.portal.kernel.exception.PortalException,
444                            com.liferay.portal.kernel.exception.SystemException {
445                    return getService()
446                                       .updateStatus(userId, layoutRevisionId, status,
447                            serviceContext);
448            }
449    
450            public static LayoutRevisionLocalService getService() {
451                    if (_service == null) {
452                            _service = (LayoutRevisionLocalService)PortalBeanLocatorUtil.locate(LayoutRevisionLocalService.class.getName());
453    
454                            ReferenceRegistry.registerReference(LayoutRevisionLocalServiceUtil.class,
455                                    "_service");
456                    }
457    
458                    return _service;
459            }
460    
461            /**
462             * @deprecated
463             */
464            public void setService(LayoutRevisionLocalService service) {
465            }
466    
467            private static LayoutRevisionLocalService _service;
468    }