001    /**
002     * Copyright (c) 2000-2011 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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the layout set branch local service. This utility wraps {@link com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * 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.
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see LayoutSetBranchLocalService
030     * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl
032     * @generated
033     */
034    public class LayoutSetBranchLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the layout set branch to the database. Also notifies the appropriate model listeners.
043            *
044            * @param layoutSetBranch the layout set branch
045            * @return the layout set branch that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
049                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addLayoutSetBranch(layoutSetBranch);
052            }
053    
054            /**
055            * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.
056            *
057            * @param layoutSetBranchId the primary key for the new layout set branch
058            * @return the new layout set branch
059            */
060            public static com.liferay.portal.model.LayoutSetBranch createLayoutSetBranch(
061                    long layoutSetBranchId) {
062                    return getService().createLayoutSetBranch(layoutSetBranchId);
063            }
064    
065            /**
066            * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param layoutSetBranchId the primary key of the layout set branch
069            * @throws PortalException if a layout set branch with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteLayoutSetBranch(long layoutSetBranchId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteLayoutSetBranch(layoutSetBranchId);
076            }
077    
078            /**
079            * Deletes the layout set branch from the database. Also notifies the appropriate model listeners.
080            *
081            * @param layoutSetBranch the layout set branch
082            * @throws PortalException
083            * @throws SystemException if a system exception occurred
084            */
085            public static void deleteLayoutSetBranch(
086                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
087                    throws com.liferay.portal.kernel.exception.PortalException,
088                            com.liferay.portal.kernel.exception.SystemException {
089                    getService().deleteLayoutSetBranch(layoutSetBranch);
090            }
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @SuppressWarnings("rawtypes")
100            public static java.util.List dynamicQuery(
101                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
102                    throws com.liferay.portal.kernel.exception.SystemException {
103                    return getService().dynamicQuery(dynamicQuery);
104            }
105    
106            /**
107            * Performs a dynamic query on the database and returns a range of the matching rows.
108            *
109            * <p>
110            * 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.
111            * </p>
112            *
113            * @param dynamicQuery the dynamic query
114            * @param start the lower bound of the range of model instances
115            * @param end the upper bound of the range of model instances (not inclusive)
116            * @return the range of matching rows
117            * @throws SystemException if a system exception occurred
118            */
119            @SuppressWarnings("rawtypes")
120            public static java.util.List dynamicQuery(
121                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
122                    int end) throws com.liferay.portal.kernel.exception.SystemException {
123                    return getService().dynamicQuery(dynamicQuery, start, end);
124            }
125    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public static java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException {
146                    return getService()
147                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
148            }
149    
150            /**
151            * Returns the number of rows that match the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @return the number of rows that match the dynamic query
155            * @throws SystemException if a system exception occurred
156            */
157            public static long dynamicQueryCount(
158                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
159                    throws com.liferay.portal.kernel.exception.SystemException {
160                    return getService().dynamicQueryCount(dynamicQuery);
161            }
162    
163            /**
164            * Returns the layout set branch with the primary key.
165            *
166            * @param layoutSetBranchId the primary key of the layout set branch
167            * @return the layout set branch
168            * @throws PortalException if a layout set branch with the primary key could not be found
169            * @throws SystemException if a system exception occurred
170            */
171            public static com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
172                    long layoutSetBranchId)
173                    throws com.liferay.portal.kernel.exception.PortalException,
174                            com.liferay.portal.kernel.exception.SystemException {
175                    return getService().getLayoutSetBranch(layoutSetBranchId);
176            }
177    
178            public static com.liferay.portal.model.PersistedModel getPersistedModel(
179                    java.io.Serializable primaryKeyObj)
180                    throws com.liferay.portal.kernel.exception.PortalException,
181                            com.liferay.portal.kernel.exception.SystemException {
182                    return getService().getPersistedModel(primaryKeyObj);
183            }
184    
185            /**
186            * Returns a range of all the layout set branchs.
187            *
188            * <p>
189            * 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.
190            * </p>
191            *
192            * @param start the lower bound of the range of layout set branchs
193            * @param end the upper bound of the range of layout set branchs (not inclusive)
194            * @return the range of layout set branchs
195            * @throws SystemException if a system exception occurred
196            */
197            public static java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranchs(
198                    int start, int end)
199                    throws com.liferay.portal.kernel.exception.SystemException {
200                    return getService().getLayoutSetBranchs(start, end);
201            }
202    
203            /**
204            * Returns the number of layout set branchs.
205            *
206            * @return the number of layout set branchs
207            * @throws SystemException if a system exception occurred
208            */
209            public static int getLayoutSetBranchsCount()
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getLayoutSetBranchsCount();
212            }
213    
214            /**
215            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
216            *
217            * @param layoutSetBranch the layout set branch
218            * @return the layout set branch that was updated
219            * @throws SystemException if a system exception occurred
220            */
221            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
222                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
223                    throws com.liferay.portal.kernel.exception.SystemException {
224                    return getService().updateLayoutSetBranch(layoutSetBranch);
225            }
226    
227            /**
228            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
229            *
230            * @param layoutSetBranch the layout set branch
231            * @param merge whether to merge the layout set branch 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.
232            * @return the layout set branch that was updated
233            * @throws SystemException if a system exception occurred
234            */
235            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
236                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch, boolean merge)
237                    throws com.liferay.portal.kernel.exception.SystemException {
238                    return getService().updateLayoutSetBranch(layoutSetBranch, merge);
239            }
240    
241            /**
242            * Returns the Spring bean ID for this bean.
243            *
244            * @return the Spring bean ID for this bean
245            */
246            public static java.lang.String getBeanIdentifier() {
247                    return getService().getBeanIdentifier();
248            }
249    
250            /**
251            * Sets the Spring bean ID for this bean.
252            *
253            * @param beanIdentifier the Spring bean ID for this bean
254            */
255            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
256                    getService().setBeanIdentifier(beanIdentifier);
257            }
258    
259            public static com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
260                    long userId, long groupId, boolean privateLayout,
261                    java.lang.String name, java.lang.String description, boolean master,
262                    long copyLayoutSetBranchId,
263                    com.liferay.portal.service.ServiceContext serviceContext)
264                    throws com.liferay.portal.kernel.exception.PortalException,
265                            com.liferay.portal.kernel.exception.SystemException {
266                    return getService()
267                                       .addLayoutSetBranch(userId, groupId, privateLayout, name,
268                            description, master, copyLayoutSetBranchId, serviceContext);
269            }
270    
271            public static void deleteLayoutSetBranch(
272                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch,
273                    boolean includeMaster)
274                    throws com.liferay.portal.kernel.exception.PortalException,
275                            com.liferay.portal.kernel.exception.SystemException {
276                    getService().deleteLayoutSetBranch(layoutSetBranch, includeMaster);
277            }
278    
279            public static void deleteLayoutSetBranches(long groupId,
280                    boolean privateLayout)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService().deleteLayoutSetBranches(groupId, privateLayout);
284            }
285    
286            public static void deleteLayoutSetBranches(long groupId,
287                    boolean privateLayout, boolean includeMaster)
288                    throws com.liferay.portal.kernel.exception.PortalException,
289                            com.liferay.portal.kernel.exception.SystemException {
290                    getService()
291                            .deleteLayoutSetBranches(groupId, privateLayout, includeMaster);
292            }
293    
294            public static com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
295                    long groupId, boolean privateLayout, java.lang.String name)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return getService().getLayoutSetBranch(groupId, privateLayout, name);
299            }
300    
301            public static java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranches(
302                    long groupId, boolean privateLayout)
303                    throws com.liferay.portal.kernel.exception.SystemException {
304                    return getService().getLayoutSetBranches(groupId, privateLayout);
305            }
306    
307            public static com.liferay.portal.model.LayoutSetBranch getMasterLayoutSetBranch(
308                    long groupId, boolean privateLayout)
309                    throws com.liferay.portal.kernel.exception.PortalException,
310                            com.liferay.portal.kernel.exception.SystemException {
311                    return getService().getMasterLayoutSetBranch(groupId, privateLayout);
312            }
313    
314            public static com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
315                    long userId, long groupId, boolean privateLayout, long layoutSetBranchId)
316                    throws com.liferay.portal.kernel.exception.PortalException,
317                            com.liferay.portal.kernel.exception.SystemException {
318                    return getService()
319                                       .getUserLayoutSetBranch(userId, groupId, privateLayout,
320                            layoutSetBranchId);
321            }
322    
323            public static com.liferay.portal.model.LayoutSetBranch mergeLayoutSetBranch(
324                    long layoutSetBranchId, long mergeLayoutSetBranchId,
325                    com.liferay.portal.service.ServiceContext serviceContext)
326                    throws com.liferay.portal.kernel.exception.PortalException,
327                            com.liferay.portal.kernel.exception.SystemException {
328                    return getService()
329                                       .mergeLayoutSetBranch(layoutSetBranchId,
330                            mergeLayoutSetBranchId, serviceContext);
331            }
332    
333            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
334                    long layoutSetBranchId, java.lang.String name,
335                    java.lang.String description,
336                    com.liferay.portal.service.ServiceContext serviceContext)
337                    throws com.liferay.portal.kernel.exception.PortalException,
338                            com.liferay.portal.kernel.exception.SystemException {
339                    return getService()
340                                       .updateLayoutSetBranch(layoutSetBranchId, name, description,
341                            serviceContext);
342            }
343    
344            public static LayoutSetBranchLocalService getService() {
345                    if (_service == null) {
346                            _service = (LayoutSetBranchLocalService)PortalBeanLocatorUtil.locate(LayoutSetBranchLocalService.class.getName());
347    
348                            ReferenceRegistry.registerReference(LayoutSetBranchLocalServiceUtil.class,
349                                    "_service");
350                            MethodCache.remove(LayoutSetBranchLocalService.class);
351                    }
352    
353                    return _service;
354            }
355    
356            public void setService(LayoutSetBranchLocalService service) {
357                    MethodCache.remove(LayoutSetBranchLocalService.class);
358    
359                    _service = service;
360    
361                    ReferenceRegistry.registerReference(LayoutSetBranchLocalServiceUtil.class,
362                            "_service");
363                    MethodCache.remove(LayoutSetBranchLocalService.class);
364            }
365    
366            private static LayoutSetBranchLocalService _service;
367    }