001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * The utility for the layout set 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.
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 LayoutSetBranchLocalService
029     * @see com.liferay.portal.service.base.LayoutSetBranchLocalServiceBaseImpl
030     * @see com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl
031     * @generated
032     */
033    public class LayoutSetBranchLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutSetBranchLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the layout set branch to the database. Also notifies the appropriate model listeners.
042            *
043            * @param layoutSetBranch the layout set branch
044            * @return the layout set branch that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
048                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addLayoutSetBranch(layoutSetBranch);
051            }
052    
053            /**
054            * Creates a new layout set branch with the primary key. Does not add the layout set branch to the database.
055            *
056            * @param layoutSetBranchId the primary key for the new layout set branch
057            * @return the new layout set branch
058            */
059            public static com.liferay.portal.model.LayoutSetBranch createLayoutSetBranch(
060                    long layoutSetBranchId) {
061                    return getService().createLayoutSetBranch(layoutSetBranchId);
062            }
063    
064            /**
065            * Deletes the layout set branch with the primary key from the database. Also notifies the appropriate model listeners.
066            *
067            * @param layoutSetBranchId the primary key of the layout set branch
068            * @return the layout set branch that was removed
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 com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch(
073                    long layoutSetBranchId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException {
076                    return getService().deleteLayoutSetBranch(layoutSetBranchId);
077            }
078    
079            /**
080            * Deletes the layout set branch from the database. Also notifies the appropriate model listeners.
081            *
082            * @param layoutSetBranch the layout set branch
083            * @return the layout set branch that was removed
084            * @throws PortalException
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch(
088                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
089                    throws com.liferay.portal.kernel.exception.PortalException,
090                            com.liferay.portal.kernel.exception.SystemException {
091                    return getService().deleteLayoutSetBranch(layoutSetBranch);
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.LayoutSetBranch fetchLayoutSetBranch(
170                    long layoutSetBranchId)
171                    throws com.liferay.portal.kernel.exception.SystemException {
172                    return getService().fetchLayoutSetBranch(layoutSetBranchId);
173            }
174    
175            /**
176            * Returns the layout set branch with the primary key.
177            *
178            * @param layoutSetBranchId the primary key of the layout set branch
179            * @return the layout set branch
180            * @throws PortalException if a layout set branch with the primary key could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            public static com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
184                    long layoutSetBranchId)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getLayoutSetBranch(layoutSetBranchId);
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 set branchs.
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 set branchs
205            * @param end the upper bound of the range of layout set branchs (not inclusive)
206            * @return the range of layout set branchs
207            * @throws SystemException if a system exception occurred
208            */
209            public static java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranchs(
210                    int start, int end)
211                    throws com.liferay.portal.kernel.exception.SystemException {
212                    return getService().getLayoutSetBranchs(start, end);
213            }
214    
215            /**
216            * Returns the number of layout set branchs.
217            *
218            * @return the number of layout set branchs
219            * @throws SystemException if a system exception occurred
220            */
221            public static int getLayoutSetBranchsCount()
222                    throws com.liferay.portal.kernel.exception.SystemException {
223                    return getService().getLayoutSetBranchsCount();
224            }
225    
226            /**
227            * Updates the layout set branch in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
228            *
229            * @param layoutSetBranch the layout set branch
230            * @return the layout set branch that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
234                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch)
235                    throws com.liferay.portal.kernel.exception.SystemException {
236                    return getService().updateLayoutSetBranch(layoutSetBranch);
237            }
238    
239            /**
240            * Returns the Spring bean ID for this bean.
241            *
242            * @return the Spring bean ID for this bean
243            */
244            public static java.lang.String getBeanIdentifier() {
245                    return getService().getBeanIdentifier();
246            }
247    
248            /**
249            * Sets the Spring bean ID for this bean.
250            *
251            * @param beanIdentifier the Spring bean ID for this bean
252            */
253            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
254                    getService().setBeanIdentifier(beanIdentifier);
255            }
256    
257            public static com.liferay.portal.model.LayoutSetBranch addLayoutSetBranch(
258                    long userId, long groupId, boolean privateLayout,
259                    java.lang.String name, java.lang.String description, boolean master,
260                    long copyLayoutSetBranchId,
261                    com.liferay.portal.service.ServiceContext serviceContext)
262                    throws com.liferay.portal.kernel.exception.PortalException,
263                            com.liferay.portal.kernel.exception.SystemException {
264                    return getService()
265                                       .addLayoutSetBranch(userId, groupId, privateLayout, name,
266                            description, master, copyLayoutSetBranchId, serviceContext);
267            }
268    
269            public static com.liferay.portal.model.LayoutSetBranch deleteLayoutSetBranch(
270                    com.liferay.portal.model.LayoutSetBranch layoutSetBranch,
271                    boolean includeMaster)
272                    throws com.liferay.portal.kernel.exception.PortalException,
273                            com.liferay.portal.kernel.exception.SystemException {
274                    return getService().deleteLayoutSetBranch(layoutSetBranch, includeMaster);
275            }
276    
277            public static void deleteLayoutSetBranches(long groupId,
278                    boolean privateLayout)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    getService().deleteLayoutSetBranches(groupId, privateLayout);
282            }
283    
284            public static void deleteLayoutSetBranches(long groupId,
285                    boolean privateLayout, boolean includeMaster)
286                    throws com.liferay.portal.kernel.exception.PortalException,
287                            com.liferay.portal.kernel.exception.SystemException {
288                    getService()
289                            .deleteLayoutSetBranches(groupId, privateLayout, includeMaster);
290            }
291    
292            public static com.liferay.portal.model.LayoutSetBranch getLayoutSetBranch(
293                    long groupId, boolean privateLayout, java.lang.String name)
294                    throws com.liferay.portal.kernel.exception.PortalException,
295                            com.liferay.portal.kernel.exception.SystemException {
296                    return getService().getLayoutSetBranch(groupId, privateLayout, name);
297            }
298    
299            public static java.util.List<com.liferay.portal.model.LayoutSetBranch> getLayoutSetBranches(
300                    long groupId, boolean privateLayout)
301                    throws com.liferay.portal.kernel.exception.SystemException {
302                    return getService().getLayoutSetBranches(groupId, privateLayout);
303            }
304    
305            public static com.liferay.portal.model.LayoutSetBranch getMasterLayoutSetBranch(
306                    long groupId, boolean privateLayout)
307                    throws com.liferay.portal.kernel.exception.PortalException,
308                            com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getMasterLayoutSetBranch(groupId, privateLayout);
310            }
311    
312            /**
313            * @deprecated {@link #getUserLayoutSetBranch(long, long, boolean, long,
314            long)}
315            */
316            public static com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
317                    long userId, long groupId, boolean privateLayout, long layoutSetBranchId)
318                    throws com.liferay.portal.kernel.exception.PortalException,
319                            com.liferay.portal.kernel.exception.SystemException {
320                    return getService()
321                                       .getUserLayoutSetBranch(userId, groupId, privateLayout,
322                            layoutSetBranchId);
323            }
324    
325            public static com.liferay.portal.model.LayoutSetBranch getUserLayoutSetBranch(
326                    long userId, long groupId, boolean privateLayout, long layoutSetId,
327                    long layoutSetBranchId)
328                    throws com.liferay.portal.kernel.exception.PortalException,
329                            com.liferay.portal.kernel.exception.SystemException {
330                    return getService()
331                                       .getUserLayoutSetBranch(userId, groupId, privateLayout,
332                            layoutSetId, layoutSetBranchId);
333            }
334    
335            public static com.liferay.portal.model.LayoutSetBranch mergeLayoutSetBranch(
336                    long layoutSetBranchId, long mergeLayoutSetBranchId,
337                    com.liferay.portal.service.ServiceContext serviceContext)
338                    throws com.liferay.portal.kernel.exception.PortalException,
339                            com.liferay.portal.kernel.exception.SystemException {
340                    return getService()
341                                       .mergeLayoutSetBranch(layoutSetBranchId,
342                            mergeLayoutSetBranchId, serviceContext);
343            }
344    
345            public static com.liferay.portal.model.LayoutSetBranch updateLayoutSetBranch(
346                    long layoutSetBranchId, java.lang.String name,
347                    java.lang.String description,
348                    com.liferay.portal.service.ServiceContext serviceContext)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException {
351                    return getService()
352                                       .updateLayoutSetBranch(layoutSetBranchId, name, description,
353                            serviceContext);
354            }
355    
356            public static LayoutSetBranchLocalService getService() {
357                    if (_service == null) {
358                            _service = (LayoutSetBranchLocalService)PortalBeanLocatorUtil.locate(LayoutSetBranchLocalService.class.getName());
359    
360                            ReferenceRegistry.registerReference(LayoutSetBranchLocalServiceUtil.class,
361                                    "_service");
362                    }
363    
364                    return _service;
365            }
366    
367            /**
368             * @deprecated
369             */
370            public void setService(LayoutSetBranchLocalService service) {
371            }
372    
373            private static LayoutSetBranchLocalService _service;
374    }