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