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