001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import 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            * @throws SystemException if a system exception occurred
039            */
040            @Override
041            public com.liferay.portal.model.Portlet addPortlet(
042                    com.liferay.portal.model.Portlet portlet)
043                    throws com.liferay.portal.kernel.exception.SystemException {
044                    return _portletLocalService.addPortlet(portlet);
045            }
046    
047            /**
048            * Creates a new portlet with the primary key. Does not add the portlet to the database.
049            *
050            * @param id the primary key for the new portlet
051            * @return the new portlet
052            */
053            @Override
054            public com.liferay.portal.model.Portlet createPortlet(long id) {
055                    return _portletLocalService.createPortlet(id);
056            }
057    
058            /**
059            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
060            *
061            * @param id the primary key of the portlet
062            * @return the portlet that was removed
063            * @throws PortalException if a portlet with the primary key could not be found
064            * @throws SystemException if a system exception occurred
065            */
066            @Override
067            public com.liferay.portal.model.Portlet deletePortlet(long id)
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException {
070                    return _portletLocalService.deletePortlet(id);
071            }
072    
073            /**
074            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
075            *
076            * @param portlet the portlet
077            * @return the portlet that was removed
078            * @throws SystemException if a system exception occurred
079            */
080            @Override
081            public com.liferay.portal.model.Portlet deletePortlet(
082                    com.liferay.portal.model.Portlet portlet)
083                    throws com.liferay.portal.kernel.exception.SystemException {
084                    return _portletLocalService.deletePortlet(portlet);
085            }
086    
087            @Override
088            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
089                    return _portletLocalService.dynamicQuery();
090            }
091    
092            /**
093            * Performs a dynamic query on the database and returns the matching rows.
094            *
095            * @param dynamicQuery the dynamic query
096            * @return the matching rows
097            * @throws SystemException if a system exception occurred
098            */
099            @Override
100            @SuppressWarnings("rawtypes")
101            public java.util.List dynamicQuery(
102                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
103                    throws com.liferay.portal.kernel.exception.SystemException {
104                    return _portletLocalService.dynamicQuery(dynamicQuery);
105            }
106    
107            /**
108            * Performs a dynamic query on the database and returns a range of the matching rows.
109            *
110            * <p>
111            * 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.
112            * </p>
113            *
114            * @param dynamicQuery the dynamic query
115            * @param start the lower bound of the range of model instances
116            * @param end the upper bound of the range of model instances (not inclusive)
117            * @return the range of matching rows
118            * @throws SystemException if a system exception occurred
119            */
120            @Override
121            @SuppressWarnings("rawtypes")
122            public java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException {
125                    return _portletLocalService.dynamicQuery(dynamicQuery, start, end);
126            }
127    
128            /**
129            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
130            *
131            * <p>
132            * 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.
133            * </p>
134            *
135            * @param dynamicQuery the dynamic query
136            * @param start the lower bound of the range of model instances
137            * @param end the upper bound of the range of model instances (not inclusive)
138            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
139            * @return the ordered range of matching rows
140            * @throws SystemException if a system exception occurred
141            */
142            @Override
143            @SuppressWarnings("rawtypes")
144            public java.util.List dynamicQuery(
145                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
146                    int end,
147                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
148                    throws com.liferay.portal.kernel.exception.SystemException {
149                    return _portletLocalService.dynamicQuery(dynamicQuery, start, end,
150                            orderByComparator);
151            }
152    
153            /**
154            * Returns the number of rows that match the dynamic query.
155            *
156            * @param dynamicQuery the dynamic query
157            * @return the number of rows that match the dynamic query
158            * @throws SystemException if a system exception occurred
159            */
160            @Override
161            public long dynamicQueryCount(
162                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return _portletLocalService.dynamicQueryCount(dynamicQuery);
165            }
166    
167            /**
168            * Returns the number of rows that match the dynamic query.
169            *
170            * @param dynamicQuery the dynamic query
171            * @param projection the projection to apply to the query
172            * @return the number of rows that match the dynamic query
173            * @throws SystemException if a system exception occurred
174            */
175            @Override
176            public long dynamicQueryCount(
177                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
178                    com.liferay.portal.kernel.dao.orm.Projection projection)
179                    throws com.liferay.portal.kernel.exception.SystemException {
180                    return _portletLocalService.dynamicQueryCount(dynamicQuery, projection);
181            }
182    
183            @Override
184            public com.liferay.portal.model.Portlet fetchPortlet(long id)
185                    throws com.liferay.portal.kernel.exception.SystemException {
186                    return _portletLocalService.fetchPortlet(id);
187            }
188    
189            /**
190            * Returns the portlet with the primary key.
191            *
192            * @param id the primary key of the portlet
193            * @return the portlet
194            * @throws PortalException if a portlet with the primary key could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            @Override
198            public com.liferay.portal.model.Portlet getPortlet(long id)
199                    throws com.liferay.portal.kernel.exception.PortalException,
200                            com.liferay.portal.kernel.exception.SystemException {
201                    return _portletLocalService.getPortlet(id);
202            }
203    
204            @Override
205            public com.liferay.portal.model.PersistedModel getPersistedModel(
206                    java.io.Serializable primaryKeyObj)
207                    throws com.liferay.portal.kernel.exception.PortalException,
208                            com.liferay.portal.kernel.exception.SystemException {
209                    return _portletLocalService.getPersistedModel(primaryKeyObj);
210            }
211    
212            /**
213            * Returns a range of all the portlets.
214            *
215            * <p>
216            * 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.
217            * </p>
218            *
219            * @param start the lower bound of the range of portlets
220            * @param end the upper bound of the range of portlets (not inclusive)
221            * @return the range of portlets
222            * @throws SystemException if a system exception occurred
223            */
224            @Override
225            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
226                    int start, int end)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return _portletLocalService.getPortlets(start, end);
229            }
230    
231            /**
232            * Returns the number of portlets.
233            *
234            * @return the number of portlets
235            * @throws SystemException if a system exception occurred
236            */
237            @Override
238            public int getPortletsCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return _portletLocalService.getPortletsCount();
241            }
242    
243            /**
244            * Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param portlet the portlet
247            * @return the portlet that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            @Override
251            public com.liferay.portal.model.Portlet updatePortlet(
252                    com.liferay.portal.model.Portlet portlet)
253                    throws com.liferay.portal.kernel.exception.SystemException {
254                    return _portletLocalService.updatePortlet(portlet);
255            }
256    
257            /**
258            * Returns the Spring bean ID for this bean.
259            *
260            * @return the Spring bean ID for this bean
261            */
262            @Override
263            public java.lang.String getBeanIdentifier() {
264                    return _portletLocalService.getBeanIdentifier();
265            }
266    
267            /**
268            * Sets the Spring bean ID for this bean.
269            *
270            * @param beanIdentifier the Spring bean ID for this bean
271            */
272            @Override
273            public void setBeanIdentifier(java.lang.String beanIdentifier) {
274                    _portletLocalService.setBeanIdentifier(beanIdentifier);
275            }
276    
277            @Override
278            public void addPortletCategory(long companyId, java.lang.String categoryName) {
279                    _portletLocalService.addPortletCategory(companyId, categoryName);
280            }
281    
282            @Override
283            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException {
286                    _portletLocalService.checkPortlet(portlet);
287            }
288    
289            @Override
290            public void checkPortlets(long companyId)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException {
293                    _portletLocalService.checkPortlets(companyId);
294            }
295    
296            @Override
297            public void clearCache() {
298                    _portletLocalService.clearCache();
299            }
300    
301            @Override
302            public void clearCompanyPortletsPool() {
303                    _portletLocalService.clearCompanyPortletsPool();
304            }
305    
306            /**
307            * @deprecated As of 6.1.0, replaced by {@link #clonePortlet(String)}
308            */
309            @Override
310            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
311                    java.lang.String portletId) {
312                    return _portletLocalService.clonePortlet(companyId, portletId);
313            }
314    
315            @Override
316            public com.liferay.portal.model.Portlet clonePortlet(
317                    java.lang.String portletId) {
318                    return _portletLocalService.clonePortlet(portletId);
319            }
320    
321            @Override
322            public void deletePortlet(long companyId, java.lang.String portletId,
323                    long plid)
324                    throws com.liferay.portal.kernel.exception.PortalException,
325                            com.liferay.portal.kernel.exception.SystemException {
326                    _portletLocalService.deletePortlet(companyId, portletId, plid);
327            }
328    
329            @Override
330            public void deletePortlets(long companyId, java.lang.String[] portletIds,
331                    long plid)
332                    throws com.liferay.portal.kernel.exception.PortalException,
333                            com.liferay.portal.kernel.exception.SystemException {
334                    _portletLocalService.deletePortlets(companyId, portletIds, plid);
335            }
336    
337            @Override
338            public com.liferay.portal.model.Portlet deployRemotePortlet(
339                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
340                    throws com.liferay.portal.kernel.exception.PortalException,
341                            com.liferay.portal.kernel.exception.SystemException {
342                    return _portletLocalService.deployRemotePortlet(portlet, categoryName);
343            }
344    
345            @Override
346            public com.liferay.portal.model.Portlet deployRemotePortlet(
347                    com.liferay.portal.model.Portlet portlet,
348                    java.lang.String[] categoryNames)
349                    throws com.liferay.portal.kernel.exception.PortalException,
350                            com.liferay.portal.kernel.exception.SystemException {
351                    return _portletLocalService.deployRemotePortlet(portlet, categoryNames);
352            }
353    
354            @Override
355            public void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
356                    _portletLocalService.destroyPortlet(portlet);
357            }
358    
359            @Override
360            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet) {
361                    _portletLocalService.destroyRemotePortlet(portlet);
362            }
363    
364            @Override
365            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays() {
366                    return _portletLocalService.getCustomAttributesDisplays();
367            }
368    
369            @Override
370            public com.liferay.portal.model.PortletCategory getEARDisplay(
371                    java.lang.String xml)
372                    throws com.liferay.portal.kernel.exception.SystemException {
373                    return _portletLocalService.getEARDisplay(xml);
374            }
375    
376            @Override
377            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets() {
378                    return _portletLocalService.getFriendlyURLMapperPortlets();
379            }
380    
381            @Override
382            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
383                    return _portletLocalService.getFriendlyURLMappers();
384            }
385    
386            @Override
387            public com.liferay.portal.model.PortletApp getPortletApp(
388                    java.lang.String servletContextName) {
389                    return _portletLocalService.getPortletApp(servletContextName);
390            }
391    
392            @Override
393            public com.liferay.portal.model.Portlet getPortletById(long companyId,
394                    java.lang.String portletId)
395                    throws com.liferay.portal.kernel.exception.SystemException {
396                    return _portletLocalService.getPortletById(companyId, portletId);
397            }
398    
399            @Override
400            public com.liferay.portal.model.Portlet getPortletById(
401                    java.lang.String portletId) {
402                    return _portletLocalService.getPortletById(portletId);
403            }
404    
405            @Override
406            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
407                    long companyId, java.lang.String strutsPath)
408                    throws com.liferay.portal.kernel.exception.SystemException {
409                    return _portletLocalService.getPortletByStrutsPath(companyId, strutsPath);
410            }
411    
412            @Override
413            public java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
414                    return _portletLocalService.getPortlets();
415            }
416    
417            @Override
418            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
419                    long companyId)
420                    throws com.liferay.portal.kernel.exception.SystemException {
421                    return _portletLocalService.getPortlets(companyId);
422            }
423    
424            @Override
425            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
426                    long companyId, boolean showSystem, boolean showPortal)
427                    throws com.liferay.portal.kernel.exception.SystemException {
428                    return _portletLocalService.getPortlets(companyId, showSystem,
429                            showPortal);
430            }
431    
432            @Override
433            public java.util.List<com.liferay.portal.model.Portlet> getScopablePortlets() {
434                    return _portletLocalService.getScopablePortlets();
435            }
436    
437            @Override
438            public com.liferay.portal.model.PortletCategory getWARDisplay(
439                    java.lang.String servletContextName, java.lang.String xml)
440                    throws com.liferay.portal.kernel.exception.SystemException {
441                    return _portletLocalService.getWARDisplay(servletContextName, xml);
442            }
443    
444            @Override
445            public boolean hasPortlet(long companyId, java.lang.String portletId)
446                    throws com.liferay.portal.kernel.exception.SystemException {
447                    return _portletLocalService.hasPortlet(companyId, portletId);
448            }
449    
450            @Override
451            public void initEAR(javax.servlet.ServletContext servletContext,
452                    java.lang.String[] xmls,
453                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
454                    _portletLocalService.initEAR(servletContext, xmls, pluginPackage);
455            }
456    
457            @Override
458            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
459                    java.lang.String servletContextName,
460                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
461                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
462                    return _portletLocalService.initWAR(servletContextName, servletContext,
463                            xmls, pluginPackage);
464            }
465    
466            @Override
467            public java.util.Map<java.lang.String, com.liferay.portal.model.Portlet> loadGetPortletsPool(
468                    long companyId)
469                    throws com.liferay.portal.kernel.exception.SystemException {
470                    return _portletLocalService.loadGetPortletsPool(companyId);
471            }
472    
473            @Override
474            public void removeCompanyPortletsPool(long companyId) {
475                    _portletLocalService.removeCompanyPortletsPool(companyId);
476            }
477    
478            @Override
479            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
480                    java.lang.String portletId, java.lang.String roles, boolean active)
481                    throws com.liferay.portal.kernel.exception.SystemException {
482                    return _portletLocalService.updatePortlet(companyId, portletId, roles,
483                            active);
484            }
485    
486            /**
487             * @deprecated As of 6.1.0, replaced by {@link #getWrappedService}
488             */
489            public PortletLocalService getWrappedPortletLocalService() {
490                    return _portletLocalService;
491            }
492    
493            /**
494             * @deprecated As of 6.1.0, replaced by {@link #setWrappedService}
495             */
496            public void setWrappedPortletLocalService(
497                    PortletLocalService portletLocalService) {
498                    _portletLocalService = portletLocalService;
499            }
500    
501            @Override
502            public PortletLocalService getWrappedService() {
503                    return _portletLocalService;
504            }
505    
506            @Override
507            public void setWrappedService(PortletLocalService portletLocalService) {
508                    _portletLocalService = portletLocalService;
509            }
510    
511            private PortletLocalService _portletLocalService;
512    }