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