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 LayoutFriendlyURL. This utility wraps
022     * {@link com.liferay.portal.service.impl.LayoutFriendlyURLLocalServiceImpl} 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 LayoutFriendlyURLLocalService
030     * @see com.liferay.portal.service.base.LayoutFriendlyURLLocalServiceBaseImpl
031     * @see com.liferay.portal.service.impl.LayoutFriendlyURLLocalServiceImpl
032     * @generated
033     */
034    public class LayoutFriendlyURLLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.LayoutFriendlyURLLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the layout friendly u r l to the database. Also notifies the appropriate model listeners.
043            *
044            * @param layoutFriendlyURL the layout friendly u r l
045            * @return the layout friendly u r l that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portal.model.LayoutFriendlyURL addLayoutFriendlyURL(
049                    com.liferay.portal.model.LayoutFriendlyURL layoutFriendlyURL)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addLayoutFriendlyURL(layoutFriendlyURL);
052            }
053    
054            /**
055            * Creates a new layout friendly u r l with the primary key. Does not add the layout friendly u r l to the database.
056            *
057            * @param layoutFriendlyURLId the primary key for the new layout friendly u r l
058            * @return the new layout friendly u r l
059            */
060            public static com.liferay.portal.model.LayoutFriendlyURL createLayoutFriendlyURL(
061                    long layoutFriendlyURLId) {
062                    return getService().createLayoutFriendlyURL(layoutFriendlyURLId);
063            }
064    
065            /**
066            * Deletes the layout friendly u r l with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param layoutFriendlyURLId the primary key of the layout friendly u r l
069            * @return the layout friendly u r l that was removed
070            * @throws PortalException if a layout friendly u r l with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public static com.liferay.portal.model.LayoutFriendlyURL deleteLayoutFriendlyURL(
074                    long layoutFriendlyURLId)
075                    throws com.liferay.portal.kernel.exception.PortalException,
076                            com.liferay.portal.kernel.exception.SystemException {
077                    return getService().deleteLayoutFriendlyURL(layoutFriendlyURLId);
078            }
079    
080            /**
081            * Deletes the layout friendly u r l from the database. Also notifies the appropriate model listeners.
082            *
083            * @param layoutFriendlyURL the layout friendly u r l
084            * @return the layout friendly u r l that was removed
085            * @throws SystemException if a system exception occurred
086            */
087            public static com.liferay.portal.model.LayoutFriendlyURL deleteLayoutFriendlyURL(
088                    com.liferay.portal.model.LayoutFriendlyURL layoutFriendlyURL)
089                    throws com.liferay.portal.kernel.exception.SystemException {
090                    return getService().deleteLayoutFriendlyURL(layoutFriendlyURL);
091            }
092    
093            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
094                    return getService().dynamicQuery();
095            }
096    
097            /**
098            * Performs a dynamic query on the database and returns the matching rows.
099            *
100            * @param dynamicQuery the dynamic query
101            * @return the matching rows
102            * @throws SystemException if a system exception occurred
103            */
104            @SuppressWarnings("rawtypes")
105            public static java.util.List dynamicQuery(
106                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
107                    throws com.liferay.portal.kernel.exception.SystemException {
108                    return getService().dynamicQuery(dynamicQuery);
109            }
110    
111            /**
112            * Performs a dynamic query on the database and returns a range of the matching rows.
113            *
114            * <p>
115            * 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.LayoutFriendlyURLModelImpl}. 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.
116            * </p>
117            *
118            * @param dynamicQuery the dynamic query
119            * @param start the lower bound of the range of model instances
120            * @param end the upper bound of the range of model instances (not inclusive)
121            * @return the range of matching rows
122            * @throws SystemException if a system exception occurred
123            */
124            @SuppressWarnings("rawtypes")
125            public static java.util.List dynamicQuery(
126                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
127                    int end) throws com.liferay.portal.kernel.exception.SystemException {
128                    return getService().dynamicQuery(dynamicQuery, start, end);
129            }
130    
131            /**
132            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
133            *
134            * <p>
135            * 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.LayoutFriendlyURLModelImpl}. 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.
136            * </p>
137            *
138            * @param dynamicQuery the dynamic query
139            * @param start the lower bound of the range of model instances
140            * @param end the upper bound of the range of model instances (not inclusive)
141            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
142            * @return the ordered range of matching rows
143            * @throws SystemException if a system exception occurred
144            */
145            @SuppressWarnings("rawtypes")
146            public static java.util.List dynamicQuery(
147                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
148                    int end,
149                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
150                    throws com.liferay.portal.kernel.exception.SystemException {
151                    return getService()
152                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
153            }
154    
155            /**
156            * Returns the number of rows that match the dynamic query.
157            *
158            * @param dynamicQuery the dynamic query
159            * @return the number of rows that match the dynamic query
160            * @throws SystemException if a system exception occurred
161            */
162            public static long dynamicQueryCount(
163                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
164                    throws com.liferay.portal.kernel.exception.SystemException {
165                    return getService().dynamicQueryCount(dynamicQuery);
166            }
167    
168            /**
169            * Returns the number of rows that match the dynamic query.
170            *
171            * @param dynamicQuery the dynamic query
172            * @param projection the projection to apply to the query
173            * @return the number of rows that match the dynamic query
174            * @throws SystemException if a system exception occurred
175            */
176            public static long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return getService().dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            public static com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL(
184                    long layoutFriendlyURLId)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return getService().fetchLayoutFriendlyURL(layoutFriendlyURLId);
187            }
188    
189            /**
190            * Returns the layout friendly u r l with the matching UUID and company.
191            *
192            * @param uuid the layout friendly u r l's UUID
193            * @param companyId the primary key of the company
194            * @return the matching layout friendly u r l, or <code>null</code> if a matching layout friendly u r l could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public static com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndCompanyId(
198                    java.lang.String uuid, long companyId)
199                    throws com.liferay.portal.kernel.exception.SystemException {
200                    return getService()
201                                       .fetchLayoutFriendlyURLByUuidAndCompanyId(uuid, companyId);
202            }
203    
204            /**
205            * Returns the layout friendly u r l matching the UUID and group.
206            *
207            * @param uuid the layout friendly u r l's UUID
208            * @param groupId the primary key of the group
209            * @return the matching layout friendly u r l, or <code>null</code> if a matching layout friendly u r l could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            public static com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURLByUuidAndGroupId(
213                    java.lang.String uuid, long groupId)
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().fetchLayoutFriendlyURLByUuidAndGroupId(uuid, groupId);
216            }
217    
218            /**
219            * Returns the layout friendly u r l with the primary key.
220            *
221            * @param layoutFriendlyURLId the primary key of the layout friendly u r l
222            * @return the layout friendly u r l
223            * @throws PortalException if a layout friendly u r l with the primary key could not be found
224            * @throws SystemException if a system exception occurred
225            */
226            public static com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURL(
227                    long layoutFriendlyURLId)
228                    throws com.liferay.portal.kernel.exception.PortalException,
229                            com.liferay.portal.kernel.exception.SystemException {
230                    return getService().getLayoutFriendlyURL(layoutFriendlyURLId);
231            }
232    
233            public static com.liferay.portal.model.PersistedModel getPersistedModel(
234                    java.io.Serializable primaryKeyObj)
235                    throws com.liferay.portal.kernel.exception.PortalException,
236                            com.liferay.portal.kernel.exception.SystemException {
237                    return getService().getPersistedModel(primaryKeyObj);
238            }
239    
240            /**
241            * Returns the layout friendly u r l with the matching UUID and company.
242            *
243            * @param uuid the layout friendly u r l's UUID
244            * @param companyId the primary key of the company
245            * @return the matching layout friendly u r l
246            * @throws PortalException if a matching layout friendly u r l could not be found
247            * @throws SystemException if a system exception occurred
248            */
249            public static com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURLByUuidAndCompanyId(
250                    java.lang.String uuid, long companyId)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException {
253                    return getService()
254                                       .getLayoutFriendlyURLByUuidAndCompanyId(uuid, companyId);
255            }
256    
257            /**
258            * Returns the layout friendly u r l matching the UUID and group.
259            *
260            * @param uuid the layout friendly u r l's UUID
261            * @param groupId the primary key of the group
262            * @return the matching layout friendly u r l
263            * @throws PortalException if a matching layout friendly u r l could not be found
264            * @throws SystemException if a system exception occurred
265            */
266            public static com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURLByUuidAndGroupId(
267                    java.lang.String uuid, long groupId)
268                    throws com.liferay.portal.kernel.exception.PortalException,
269                            com.liferay.portal.kernel.exception.SystemException {
270                    return getService().getLayoutFriendlyURLByUuidAndGroupId(uuid, groupId);
271            }
272    
273            /**
274            * Returns a range of all the layout friendly u r ls.
275            *
276            * <p>
277            * 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.LayoutFriendlyURLModelImpl}. 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.
278            * </p>
279            *
280            * @param start the lower bound of the range of layout friendly u r ls
281            * @param end the upper bound of the range of layout friendly u r ls (not inclusive)
282            * @return the range of layout friendly u r ls
283            * @throws SystemException if a system exception occurred
284            */
285            public static java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLs(
286                    int start, int end)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    return getService().getLayoutFriendlyURLs(start, end);
289            }
290    
291            /**
292            * Returns the number of layout friendly u r ls.
293            *
294            * @return the number of layout friendly u r ls
295            * @throws SystemException if a system exception occurred
296            */
297            public static int getLayoutFriendlyURLsCount()
298                    throws com.liferay.portal.kernel.exception.SystemException {
299                    return getService().getLayoutFriendlyURLsCount();
300            }
301    
302            /**
303            * Updates the layout friendly u r l in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
304            *
305            * @param layoutFriendlyURL the layout friendly u r l
306            * @return the layout friendly u r l that was updated
307            * @throws SystemException if a system exception occurred
308            */
309            public static com.liferay.portal.model.LayoutFriendlyURL updateLayoutFriendlyURL(
310                    com.liferay.portal.model.LayoutFriendlyURL layoutFriendlyURL)
311                    throws com.liferay.portal.kernel.exception.SystemException {
312                    return getService().updateLayoutFriendlyURL(layoutFriendlyURL);
313            }
314    
315            /**
316            * Returns the Spring bean ID for this bean.
317            *
318            * @return the Spring bean ID for this bean
319            */
320            public static java.lang.String getBeanIdentifier() {
321                    return getService().getBeanIdentifier();
322            }
323    
324            /**
325            * Sets the Spring bean ID for this bean.
326            *
327            * @param beanIdentifier the Spring bean ID for this bean
328            */
329            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
330                    getService().setBeanIdentifier(beanIdentifier);
331            }
332    
333            public static com.liferay.portal.model.LayoutFriendlyURL addLayoutFriendlyURL(
334                    long userId, long companyId, long groupId, long plid,
335                    boolean privateLayout, java.lang.String friendlyURL,
336                    java.lang.String languageId,
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                                       .addLayoutFriendlyURL(userId, companyId, groupId, plid,
342                            privateLayout, friendlyURL, languageId, serviceContext);
343            }
344    
345            public static java.util.List<com.liferay.portal.model.LayoutFriendlyURL> addLayoutFriendlyURLs(
346                    long userId, long companyId, long groupId, long plid,
347                    boolean privateLayout,
348                    java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap,
349                    com.liferay.portal.service.ServiceContext serviceContext)
350                    throws com.liferay.portal.kernel.exception.PortalException,
351                            com.liferay.portal.kernel.exception.SystemException {
352                    return getService()
353                                       .addLayoutFriendlyURLs(userId, companyId, groupId, plid,
354                            privateLayout, friendlyURLMap, serviceContext);
355            }
356    
357            public static void deleteLayoutFriendlyURL(long plid,
358                    java.lang.String languageId)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    getService().deleteLayoutFriendlyURL(plid, languageId);
361            }
362    
363            public static void deleteLayoutFriendlyURLs(long plid)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    getService().deleteLayoutFriendlyURLs(plid);
366            }
367    
368            public static com.liferay.portal.model.LayoutFriendlyURL fetchFirstLayoutFriendlyURL(
369                    long groupId, boolean privateLayout, java.lang.String friendlyURL)
370                    throws com.liferay.portal.kernel.exception.SystemException {
371                    return getService()
372                                       .fetchFirstLayoutFriendlyURL(groupId, privateLayout,
373                            friendlyURL);
374            }
375    
376            public static com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL(
377                    long groupId, boolean privateLayout, java.lang.String friendlyURL,
378                    java.lang.String languageId)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService()
381                                       .fetchLayoutFriendlyURL(groupId, privateLayout, friendlyURL,
382                            languageId);
383            }
384    
385            public static com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL(
386                    long plid, java.lang.String languageId)
387                    throws com.liferay.portal.kernel.exception.SystemException {
388                    return getService().fetchLayoutFriendlyURL(plid, languageId);
389            }
390    
391            public static com.liferay.portal.model.LayoutFriendlyURL fetchLayoutFriendlyURL(
392                    long plid, java.lang.String languageId, boolean useDefault)
393                    throws com.liferay.portal.kernel.exception.SystemException {
394                    return getService().fetchLayoutFriendlyURL(plid, languageId, useDefault);
395            }
396    
397            public static com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURL(
398                    long plid, java.lang.String languageId)
399                    throws com.liferay.portal.kernel.exception.PortalException,
400                            com.liferay.portal.kernel.exception.SystemException {
401                    return getService().getLayoutFriendlyURL(plid, languageId);
402            }
403    
404            public static com.liferay.portal.model.LayoutFriendlyURL getLayoutFriendlyURL(
405                    long plid, java.lang.String languageId, boolean useDefault)
406                    throws com.liferay.portal.kernel.exception.PortalException,
407                            com.liferay.portal.kernel.exception.SystemException {
408                    return getService().getLayoutFriendlyURL(plid, languageId, useDefault);
409            }
410    
411            public static java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLs(
412                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
413                    return getService().getLayoutFriendlyURLs(plid);
414            }
415    
416            public static java.util.List<com.liferay.portal.model.LayoutFriendlyURL> getLayoutFriendlyURLs(
417                    long plid, java.lang.String friendlyURL, int start, int end)
418                    throws com.liferay.portal.kernel.exception.SystemException {
419                    return getService().getLayoutFriendlyURLs(plid, friendlyURL, start, end);
420            }
421    
422            public static com.liferay.portal.model.LayoutFriendlyURL updateLayoutFriendlyURL(
423                    long userId, long companyId, long groupId, long plid,
424                    boolean privateLayout, java.lang.String friendlyURL,
425                    java.lang.String languageId,
426                    com.liferay.portal.service.ServiceContext serviceContext)
427                    throws com.liferay.portal.kernel.exception.PortalException,
428                            com.liferay.portal.kernel.exception.SystemException {
429                    return getService()
430                                       .updateLayoutFriendlyURL(userId, companyId, groupId, plid,
431                            privateLayout, friendlyURL, languageId, serviceContext);
432            }
433    
434            public static java.util.List<com.liferay.portal.model.LayoutFriendlyURL> updateLayoutFriendlyURLs(
435                    long userId, long companyId, long groupId, long plid,
436                    boolean privateLayout,
437                    java.util.Map<java.util.Locale, java.lang.String> friendlyURLMap,
438                    com.liferay.portal.service.ServiceContext serviceContext)
439                    throws com.liferay.portal.kernel.exception.PortalException,
440                            com.liferay.portal.kernel.exception.SystemException {
441                    return getService()
442                                       .updateLayoutFriendlyURLs(userId, companyId, groupId, plid,
443                            privateLayout, friendlyURLMap, serviceContext);
444            }
445    
446            public static LayoutFriendlyURLLocalService getService() {
447                    if (_service == null) {
448                            _service = (LayoutFriendlyURLLocalService)PortalBeanLocatorUtil.locate(LayoutFriendlyURLLocalService.class.getName());
449    
450                            ReferenceRegistry.registerReference(LayoutFriendlyURLLocalServiceUtil.class,
451                                    "_service");
452                    }
453    
454                    return _service;
455            }
456    
457            /**
458             * @deprecated As of 6.2.0
459             */
460            public void setService(LayoutFriendlyURLLocalService service) {
461            }
462    
463            private static LayoutFriendlyURLLocalService _service;
464    }