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