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.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            public static com.liferay.portal.model.LayoutSetBranch fetchLayoutSetBranch(
164                    long layoutSetBranchId)
165                    throws com.liferay.portal.kernel.exception.SystemException {
166                    return getService().fetchLayoutSetBranch(layoutSetBranchId);
167            }
168    
169            /**
170            * Returns the layout set branch with the primary key.
171            *
172            * @param layoutSetBranchId the primary key of the layout set branch
173            * @return the layout set branch
174            * @throws PortalException if a layout set branch with the primary key could not be found
175            * @throws SystemException if a system exception occurred
176            */
177            public static com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
178                    long layoutSetBranchId)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException {
181                    return getService().getLayoutSetBranch(layoutSetBranchId);
182            }
183    
184            public static com.liferay.portal.model.PersistedModel getPersistedModel(
185                    java.io.Serializable primaryKeyObj)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException {
188                    return getService().getPersistedModel(primaryKeyObj);
189            }
190    
191            /**
192            * Returns a range of all the layout set branchs.
193            *
194            * <p>
195            * 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.
196            * </p>
197            *
198            * @param start the lower bound of the range of layout set branchs
199            * @param end the upper bound of the range of layout set branchs (not inclusive)
200            * @return the range of layout set branchs
201            * @throws SystemException if a system exception occurred
202            */
203            public static java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranchs(
204                    int start, int end)
205                    throws com.liferay.portal.kernel.exception.SystemException {
206                    return getService().getLayoutSetBranchs(start, end);
207            }
208    
209            /**
210            * Returns the number of layout set branchs.
211            *
212            * @return the number of layout set branchs
213            * @throws SystemException if a system exception occurred
214            */
215            public static int getLayoutSetBranchsCount()
216                    throws com.liferay.portal.kernel.exception.SystemException {
217                    return getService().getLayoutSetBranchsCount();
218            }
219    
220            /**
221            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
222            *
223            * @param layoutSetBranch the layout set branch
224            * @return the layout set branch that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
228                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
229                    throws com.liferay.portal.kernel.exception.SystemException {
230                    return getService().updateLayoutSetBranch(layoutSetBranch);
231            }
232    
233            /**
234            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
235            *
236            * @param layoutSetBranch the layout set branch
237            * @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.
238            * @return the layout set branch that was updated
239            * @throws SystemException if a system exception occurred
240            */
241            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
242                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch, boolean merge)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().updateLayoutSetBranch(layoutSetBranch, merge);
245            }
246    
247            /**
248            * Returns the Spring bean ID for this bean.
249            *
250            * @return the Spring bean ID for this bean
251            */
252            public static java.lang.String getBeanIdentifier() {
253                    return getService().getBeanIdentifier();
254            }
255    
256            /**
257            * Sets the Spring bean ID for this bean.
258            *
259            * @param beanIdentifier the Spring bean ID for this bean
260            */
261            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
262                    getService().setBeanIdentifier(beanIdentifier);
263            }
264    
265            public static com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
266                    long userId, long groupId, boolean privateLayout,
267                    java.lang.String name, java.lang.String description, boolean master,
268                    long copyLayoutSetBranchId,
269                    com.liferay.portal.service.ServiceContext serviceContext)
270                    throws com.liferay.portal.kernel.exception.PortalException,
271                            com.liferay.portal.kernel.exception.SystemException {
272                    return getService()
273                                       .addLayoutSetBranch(userId, groupId, privateLayout, name,
274                            description, master, copyLayoutSetBranchId, serviceContext);
275            }
276    
277            public static void deleteLayoutSetBranch(
278                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch,
279                    boolean includeMaster)
280                    throws com.liferay.portal.kernel.exception.PortalException,
281                            com.liferay.portal.kernel.exception.SystemException {
282                    getService().deleteLayoutSetBranch(layoutSetBranch, includeMaster);
283            }
284    
285            public static void deleteLayoutSetBranches(long groupId,
286                    boolean privateLayout)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    getService().deleteLayoutSetBranches(groupId, privateLayout);
290            }
291    
292            public static void deleteLayoutSetBranches(long groupId,
293                    boolean privateLayout, boolean includeMaster)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    getService()
297                            .deleteLayoutSetBranches(groupId, privateLayout, includeMaster);
298            }
299    
300            public static com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
301                    long groupId, boolean privateLayout, java.lang.String name)
302                    throws com.liferay.portal.kernel.exception.PortalException,
303                            com.liferay.portal.kernel.exception.SystemException {
304                    return getService().getLayoutSetBranch(groupId, privateLayout, name);
305            }
306    
307            public static java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranches(
308                    long groupId, boolean privateLayout)
309                    throws com.liferay.portal.kernel.exception.SystemException {
310                    return getService().getLayoutSetBranches(groupId, privateLayout);
311            }
312    
313            public static com.liferay.portal.model.LayoutSetBranch getMasterLayoutSetBranch(
314                    long groupId, boolean privateLayout)
315                    throws com.liferay.portal.kernel.exception.PortalException,
316                            com.liferay.portal.kernel.exception.SystemException {
317                    return getService().getMasterLayoutSetBranch(groupId, privateLayout);
318            }
319    
320            /**
321            * @deprecated {@link #getUserLayoutSetBranch(long, long, boolean, long, long)}
322            */
323            public static com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
324                    long userId, long groupId, boolean privateLayout, long layoutSetBranchId)
325                    throws com.liferay.portal.kernel.exception.PortalException,
326                            com.liferay.portal.kernel.exception.SystemException {
327                    return getService()
328                                       .getUserLayoutSetBranch(userId, groupId, privateLayout,
329                            layoutSetBranchId);
330            }
331    
332            public static com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
333                    long userId, long groupId, boolean privateLayout, long layoutSetId,
334                    long layoutSetBranchId)
335                    throws com.liferay.portal.kernel.exception.PortalException,
336                            com.liferay.portal.kernel.exception.SystemException {
337                    return getService()
338                                       .getUserLayoutSetBranch(userId, groupId, privateLayout,
339                            layoutSetId, layoutSetBranchId);
340            }
341    
342            public static com.liferay.portal.model.LayoutSetBranch mergeLayoutSetBranch(
343                    long layoutSetBranchId, long mergeLayoutSetBranchId,
344                    com.liferay.portal.service.ServiceContext serviceContext)
345                    throws com.liferay.portal.kernel.exception.PortalException,
346                            com.liferay.portal.kernel.exception.SystemException {
347                    return getService()
348                                       .mergeLayoutSetBranch(layoutSetBranchId,
349                            mergeLayoutSetBranchId, serviceContext);
350            }
351    
352            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
353                    long layoutSetBranchId, java.lang.String name,
354                    java.lang.String description,
355                    com.liferay.portal.service.ServiceContext serviceContext)
356                    throws com.liferay.portal.kernel.exception.PortalException,
357                            com.liferay.portal.kernel.exception.SystemException {
358                    return getService()
359                                       .updateLayoutSetBranch(layoutSetBranchId, name, description,
360                            serviceContext);
361            }
362    
363            public static LayoutSetBranchLocalService getService() {
364                    if (_service == null) {
365                            _service = (LayoutSetBranchLocalService)PortalBeanLocatorUtil.locate(LayoutSetBranchLocalService.class.getName());
366    
367                            ReferenceRegistry.registerReference(LayoutSetBranchLocalServiceUtil.class,
368                                    "_service");
369                            MethodCache.remove(LayoutSetBranchLocalService.class);
370                    }
371    
372                    return _service;
373            }
374    
375            public void setService(LayoutSetBranchLocalService service) {
376                    MethodCache.remove(LayoutSetBranchLocalService.class);
377    
378                    _service = service;
379    
380                    ReferenceRegistry.registerReference(LayoutSetBranchLocalServiceUtil.class,
381                            "_service");
382                    MethodCache.remove(LayoutSetBranchLocalService.class);
383            }
384    
385            private static LayoutSetBranchLocalService _service;
386    }