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