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