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    /**
020     * Provides a wrapper for {@link PortletLocalService}.
021     *
022     * @author Brian Wing Shun Chan
023     * @see PortletLocalService
024     * @generated
025     */
026    @ProviderType
027    public class PortletLocalServiceWrapper implements PortletLocalService,
028            ServiceWrapper<PortletLocalService> {
029            public PortletLocalServiceWrapper(PortletLocalService portletLocalService) {
030                    _portletLocalService = portletLocalService;
031            }
032    
033            /**
034            * Adds the portlet to the database. Also notifies the appropriate model listeners.
035            *
036            * @param portlet the portlet
037            * @return the portlet that was added
038            */
039            @Override
040            public com.liferay.portal.model.Portlet addPortlet(
041                    com.liferay.portal.model.Portlet portlet) {
042                    return _portletLocalService.addPortlet(portlet);
043            }
044    
045            @Override
046            public void addPortletCategory(long companyId, java.lang.String categoryName) {
047                    _portletLocalService.addPortletCategory(companyId, categoryName);
048            }
049    
050            @Override
051            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
052                    throws com.liferay.portal.kernel.exception.PortalException {
053                    _portletLocalService.checkPortlet(portlet);
054            }
055    
056            @Override
057            public void checkPortlets(long companyId)
058                    throws com.liferay.portal.kernel.exception.PortalException {
059                    _portletLocalService.checkPortlets(companyId);
060            }
061    
062            @Override
063            public void clearCache() {
064                    _portletLocalService.clearCache();
065            }
066    
067            /**
068            * @deprecated As of 7.0.0, replaced by {@link #clearPortletsMap)}
069            */
070            @Deprecated
071            @Override
072            public void clearCompanyPortletsPool() {
073                    _portletLocalService.clearCompanyPortletsPool();
074            }
075    
076            @Override
077            public void clearPortletsMap() {
078                    _portletLocalService.clearPortletsMap();
079            }
080    
081            /**
082            * @deprecated As of 6.1.0, replaced by {@link #clonePortlet(String)}
083            */
084            @Deprecated
085            @Override
086            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
087                    java.lang.String portletId) {
088                    return _portletLocalService.clonePortlet(companyId, portletId);
089            }
090    
091            @Override
092            public com.liferay.portal.model.Portlet clonePortlet(
093                    java.lang.String portletId) {
094                    return _portletLocalService.clonePortlet(portletId);
095            }
096    
097            /**
098            * Creates a new portlet with the primary key. Does not add the portlet to the database.
099            *
100            * @param id the primary key for the new portlet
101            * @return the new portlet
102            */
103            @Override
104            public com.liferay.portal.model.Portlet createPortlet(long id) {
105                    return _portletLocalService.createPortlet(id);
106            }
107    
108            /**
109            * @throws PortalException
110            */
111            @Override
112            public com.liferay.portal.model.PersistedModel deletePersistedModel(
113                    com.liferay.portal.model.PersistedModel persistedModel)
114                    throws com.liferay.portal.kernel.exception.PortalException {
115                    return _portletLocalService.deletePersistedModel(persistedModel);
116            }
117    
118            @Override
119            public void deletePortlet(long companyId, java.lang.String portletId,
120                    long plid) throws com.liferay.portal.kernel.exception.PortalException {
121                    _portletLocalService.deletePortlet(companyId, portletId, plid);
122            }
123    
124            /**
125            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
126            *
127            * @param id the primary key of the portlet
128            * @return the portlet that was removed
129            * @throws PortalException if a portlet with the primary key could not be found
130            */
131            @Override
132            public com.liferay.portal.model.Portlet deletePortlet(long id)
133                    throws com.liferay.portal.kernel.exception.PortalException {
134                    return _portletLocalService.deletePortlet(id);
135            }
136    
137            /**
138            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
139            *
140            * @param portlet the portlet
141            * @return the portlet that was removed
142            */
143            @Override
144            public com.liferay.portal.model.Portlet deletePortlet(
145                    com.liferay.portal.model.Portlet portlet) {
146                    return _portletLocalService.deletePortlet(portlet);
147            }
148    
149            @Override
150            public void deletePortlets(long companyId, java.lang.String[] portletIds,
151                    long plid) throws com.liferay.portal.kernel.exception.PortalException {
152                    _portletLocalService.deletePortlets(companyId, portletIds, plid);
153            }
154    
155            @Override
156            public com.liferay.portal.model.Portlet deployRemotePortlet(
157                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
158                    throws com.liferay.portal.kernel.exception.PortalException {
159                    return _portletLocalService.deployRemotePortlet(portlet, categoryName);
160            }
161    
162            @Override
163            public com.liferay.portal.model.Portlet deployRemotePortlet(
164                    com.liferay.portal.model.Portlet portlet,
165                    java.lang.String[] categoryNames)
166                    throws com.liferay.portal.kernel.exception.PortalException {
167                    return _portletLocalService.deployRemotePortlet(portlet, categoryNames);
168            }
169    
170            @Override
171            public com.liferay.portal.model.Portlet deployRemotePortlet(
172                    com.liferay.portal.model.Portlet portlet,
173                    java.lang.String[] categoryNames, boolean eagerDestroy)
174                    throws com.liferay.portal.kernel.exception.PortalException {
175                    return _portletLocalService.deployRemotePortlet(portlet, categoryNames,
176                            eagerDestroy);
177            }
178    
179            @Override
180            public void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
181                    _portletLocalService.destroyPortlet(portlet);
182            }
183    
184            @Override
185            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet) {
186                    _portletLocalService.destroyRemotePortlet(portlet);
187            }
188    
189            @Override
190            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
191                    return _portletLocalService.dynamicQuery();
192            }
193    
194            /**
195            * Performs a dynamic query on the database and returns the matching rows.
196            *
197            * @param dynamicQuery the dynamic query
198            * @return the matching rows
199            */
200            @Override
201            public <T> java.util.List<T> dynamicQuery(
202                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
203                    return _portletLocalService.dynamicQuery(dynamicQuery);
204            }
205    
206            /**
207            * Performs a dynamic query on the database and returns a range of the matching rows.
208            *
209            * <p>
210            * 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.PortletModelImpl}. 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.
211            * </p>
212            *
213            * @param dynamicQuery the dynamic query
214            * @param start the lower bound of the range of model instances
215            * @param end the upper bound of the range of model instances (not inclusive)
216            * @return the range of matching rows
217            */
218            @Override
219            public <T> java.util.List<T> dynamicQuery(
220                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
221                    int end) {
222                    return _portletLocalService.dynamicQuery(dynamicQuery, start, end);
223            }
224    
225            /**
226            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
227            *
228            * <p>
229            * 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.PortletModelImpl}. 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.
230            * </p>
231            *
232            * @param dynamicQuery the dynamic query
233            * @param start the lower bound of the range of model instances
234            * @param end the upper bound of the range of model instances (not inclusive)
235            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
236            * @return the ordered range of matching rows
237            */
238            @Override
239            public <T> java.util.List<T> dynamicQuery(
240                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
241                    int end,
242                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) {
243                    return _portletLocalService.dynamicQuery(dynamicQuery, start, end,
244                            orderByComparator);
245            }
246    
247            /**
248            * Returns the number of rows matching the dynamic query.
249            *
250            * @param dynamicQuery the dynamic query
251            * @return the number of rows matching the dynamic query
252            */
253            @Override
254            public long dynamicQueryCount(
255                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
256                    return _portletLocalService.dynamicQueryCount(dynamicQuery);
257            }
258    
259            /**
260            * Returns the number of rows matching the dynamic query.
261            *
262            * @param dynamicQuery the dynamic query
263            * @param projection the projection to apply to the query
264            * @return the number of rows matching the dynamic query
265            */
266            @Override
267            public long dynamicQueryCount(
268                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
269                    com.liferay.portal.kernel.dao.orm.Projection projection) {
270                    return _portletLocalService.dynamicQueryCount(dynamicQuery, projection);
271            }
272    
273            @Override
274            public com.liferay.portal.model.Portlet fetchPortlet(long id) {
275                    return _portletLocalService.fetchPortlet(id);
276            }
277    
278            @Override
279            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
280                    return _portletLocalService.getActionableDynamicQuery();
281            }
282    
283            @Override
284            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays() {
285                    return _portletLocalService.getCustomAttributesDisplays();
286            }
287    
288            @Override
289            public com.liferay.portal.model.PortletCategory getEARDisplay(
290                    java.lang.String xml) {
291                    return _portletLocalService.getEARDisplay(xml);
292            }
293    
294            @Override
295            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets() {
296                    return _portletLocalService.getFriendlyURLMapperPortlets();
297            }
298    
299            @Override
300            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
301                    return _portletLocalService.getFriendlyURLMappers();
302            }
303    
304            @Override
305            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() {
306                    return _portletLocalService.getIndexableActionableDynamicQuery();
307            }
308    
309            /**
310            * Returns the OSGi service identifier.
311            *
312            * @return the OSGi service identifier
313            */
314            @Override
315            public java.lang.String getOSGiServiceIdentifier() {
316                    return _portletLocalService.getOSGiServiceIdentifier();
317            }
318    
319            @Override
320            public com.liferay.portal.model.PersistedModel getPersistedModel(
321                    java.io.Serializable primaryKeyObj)
322                    throws com.liferay.portal.kernel.exception.PortalException {
323                    return _portletLocalService.getPersistedModel(primaryKeyObj);
324            }
325    
326            /**
327            * Returns the portlet with the primary key.
328            *
329            * @param id the primary key of the portlet
330            * @return the portlet
331            * @throws PortalException if a portlet with the primary key could not be found
332            */
333            @Override
334            public com.liferay.portal.model.Portlet getPortlet(long id)
335                    throws com.liferay.portal.kernel.exception.PortalException {
336                    return _portletLocalService.getPortlet(id);
337            }
338    
339            @Override
340            public com.liferay.portal.model.PortletApp getPortletApp(
341                    java.lang.String servletContextName) {
342                    return _portletLocalService.getPortletApp(servletContextName);
343            }
344    
345            @Override
346            public com.liferay.portal.model.Portlet getPortletById(long companyId,
347                    java.lang.String portletId) {
348                    return _portletLocalService.getPortletById(companyId, portletId);
349            }
350    
351            @Override
352            public com.liferay.portal.model.Portlet getPortletById(
353                    java.lang.String portletId) {
354                    return _portletLocalService.getPortletById(portletId);
355            }
356    
357            @Override
358            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
359                    long companyId, java.lang.String strutsPath) {
360                    return _portletLocalService.getPortletByStrutsPath(companyId, strutsPath);
361            }
362    
363            @Override
364            public java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
365                    return _portletLocalService.getPortlets();
366            }
367    
368            @Override
369            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
370                    long companyId) {
371                    return _portletLocalService.getPortlets(companyId);
372            }
373    
374            @Override
375            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
376                    long companyId, boolean showSystem, boolean showPortal) {
377                    return _portletLocalService.getPortlets(companyId, showSystem,
378                            showPortal);
379            }
380    
381            /**
382            * Returns a range of all the portlets.
383            *
384            * <p>
385            * 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.PortletModelImpl}. 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.
386            * </p>
387            *
388            * @param start the lower bound of the range of portlets
389            * @param end the upper bound of the range of portlets (not inclusive)
390            * @return the range of portlets
391            */
392            @Override
393            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
394                    int start, int end) {
395                    return _portletLocalService.getPortlets(start, end);
396            }
397    
398            /**
399            * Returns the number of portlets.
400            *
401            * @return the number of portlets
402            */
403            @Override
404            public int getPortletsCount() {
405                    return _portletLocalService.getPortletsCount();
406            }
407    
408            @Override
409            public java.util.List<com.liferay.portal.model.Portlet> getScopablePortlets() {
410                    return _portletLocalService.getScopablePortlets();
411            }
412    
413            @Override
414            public com.liferay.portal.model.PortletCategory getWARDisplay(
415                    java.lang.String servletContextName, java.lang.String xml) {
416                    return _portletLocalService.getWARDisplay(servletContextName, xml);
417            }
418    
419            @Override
420            public boolean hasPortlet(long companyId, java.lang.String portletId) {
421                    return _portletLocalService.hasPortlet(companyId, portletId);
422            }
423    
424            @Override
425            public void initEAR(javax.servlet.ServletContext servletContext,
426                    java.lang.String[] xmls,
427                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
428                    _portletLocalService.initEAR(servletContext, xmls, pluginPackage);
429            }
430    
431            @Override
432            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
433                    java.lang.String servletContextName,
434                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
435                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
436                    return _portletLocalService.initWAR(servletContextName, servletContext,
437                            xmls, pluginPackage);
438            }
439    
440            @Override
441            public java.util.Map<java.lang.String, com.liferay.portal.model.Portlet> loadGetPortletsMap(
442                    long companyId) {
443                    return _portletLocalService.loadGetPortletsMap(companyId);
444            }
445    
446            /**
447            * @deprecated As of 7.0.0, replaced by {@link #loadGetPortletsMap(long))}
448            */
449            @Deprecated
450            @Override
451            public java.util.Map<java.lang.String, com.liferay.portal.model.Portlet> loadGetPortletsPool(
452                    long companyId) {
453                    return _portletLocalService.loadGetPortletsPool(companyId);
454            }
455    
456            @Override
457            public void removeCompanyPortletsPool(long companyId) {
458                    _portletLocalService.removeCompanyPortletsPool(companyId);
459            }
460    
461            @Override
462            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
463                    java.lang.String portletId, java.lang.String roles, boolean active) {
464                    return _portletLocalService.updatePortlet(companyId, portletId, roles,
465                            active);
466            }
467    
468            /**
469            * Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
470            *
471            * @param portlet the portlet
472            * @return the portlet that was updated
473            */
474            @Override
475            public com.liferay.portal.model.Portlet updatePortlet(
476                    com.liferay.portal.model.Portlet portlet) {
477                    return _portletLocalService.updatePortlet(portlet);
478            }
479    
480            @Override
481            public PortletLocalService getWrappedService() {
482                    return _portletLocalService;
483            }
484    
485            @Override
486            public void setWrappedService(PortletLocalService portletLocalService) {
487                    _portletLocalService = portletLocalService;
488            }
489    
490            private PortletLocalService _portletLocalService;
491    }