001    /**
002     * Copyright (c) 2000-2012 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. 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.
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. 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.
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. 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.
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            * Returns the Spring bean ID for this bean.
227            *
228            * @return the Spring bean ID for this bean
229            */
230            public java.lang.String getBeanIdentifier() {
231                    return _portletLocalService.getBeanIdentifier();
232            }
233    
234            /**
235            * Sets the Spring bean ID for this bean.
236            *
237            * @param beanIdentifier the Spring bean ID for this bean
238            */
239            public void setBeanIdentifier(java.lang.String beanIdentifier) {
240                    _portletLocalService.setBeanIdentifier(beanIdentifier);
241            }
242    
243            public void addPortletCategory(long companyId, java.lang.String categoryName) {
244                    _portletLocalService.addPortletCategory(companyId, categoryName);
245            }
246    
247            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
248                    throws com.liferay.portal.kernel.exception.PortalException,
249                            com.liferay.portal.kernel.exception.SystemException {
250                    _portletLocalService.checkPortlet(portlet);
251            }
252    
253            public void checkPortlets(long companyId)
254                    throws com.liferay.portal.kernel.exception.PortalException,
255                            com.liferay.portal.kernel.exception.SystemException {
256                    _portletLocalService.checkPortlets(companyId);
257            }
258    
259            public void clearCache() {
260                    _portletLocalService.clearCache();
261            }
262    
263            public void clearCompanyPortletsPool() {
264                    _portletLocalService.clearCompanyPortletsPool();
265            }
266    
267            /**
268            * @deprecated {@link #clonePortlet(String)}
269            */
270            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
271                    java.lang.String portletId) {
272                    return _portletLocalService.clonePortlet(companyId, portletId);
273            }
274    
275            public com.liferay.portal.model.Portlet clonePortlet(
276                    java.lang.String portletId) {
277                    return _portletLocalService.clonePortlet(portletId);
278            }
279    
280            public void deletePortlet(long companyId, java.lang.String portletId,
281                    long plid)
282                    throws com.liferay.portal.kernel.exception.PortalException,
283                            com.liferay.portal.kernel.exception.SystemException {
284                    _portletLocalService.deletePortlet(companyId, portletId, plid);
285            }
286    
287            public void deletePortlets(long companyId, java.lang.String[] portletIds,
288                    long plid)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException {
291                    _portletLocalService.deletePortlets(companyId, portletIds, plid);
292            }
293    
294            public com.liferay.portal.model.Portlet deployRemotePortlet(
295                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
296                    throws com.liferay.portal.kernel.exception.PortalException,
297                            com.liferay.portal.kernel.exception.SystemException {
298                    return _portletLocalService.deployRemotePortlet(portlet, categoryName);
299            }
300    
301            public com.liferay.portal.model.Portlet deployRemotePortlet(
302                    com.liferay.portal.model.Portlet portlet,
303                    java.lang.String[] categoryNames)
304                    throws com.liferay.portal.kernel.exception.PortalException,
305                            com.liferay.portal.kernel.exception.SystemException {
306                    return _portletLocalService.deployRemotePortlet(portlet, categoryNames);
307            }
308    
309            public void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
310                    _portletLocalService.destroyPortlet(portlet);
311            }
312    
313            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet) {
314                    _portletLocalService.destroyRemotePortlet(portlet);
315            }
316    
317            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays() {
318                    return _portletLocalService.getCustomAttributesDisplays();
319            }
320    
321            public com.liferay.portal.model.PortletCategory getEARDisplay(
322                    java.lang.String xml)
323                    throws com.liferay.portal.kernel.exception.SystemException {
324                    return _portletLocalService.getEARDisplay(xml);
325            }
326    
327            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets() {
328                    return _portletLocalService.getFriendlyURLMapperPortlets();
329            }
330    
331            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
332                    return _portletLocalService.getFriendlyURLMappers();
333            }
334    
335            public com.liferay.portal.model.PortletApp getPortletApp(
336                    java.lang.String servletContextName) {
337                    return _portletLocalService.getPortletApp(servletContextName);
338            }
339    
340            public com.liferay.portal.model.Portlet getPortletById(long companyId,
341                    java.lang.String portletId)
342                    throws com.liferay.portal.kernel.exception.SystemException {
343                    return _portletLocalService.getPortletById(companyId, portletId);
344            }
345    
346            public com.liferay.portal.model.Portlet getPortletById(
347                    java.lang.String portletId) {
348                    return _portletLocalService.getPortletById(portletId);
349            }
350    
351            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
352                    long companyId, java.lang.String strutsPath)
353                    throws com.liferay.portal.kernel.exception.SystemException {
354                    return _portletLocalService.getPortletByStrutsPath(companyId, strutsPath);
355            }
356    
357            public java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
358                    return _portletLocalService.getPortlets();
359            }
360    
361            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
362                    long companyId)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return _portletLocalService.getPortlets(companyId);
365            }
366    
367            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
368                    long companyId, boolean showSystem, boolean showPortal)
369                    throws com.liferay.portal.kernel.exception.SystemException {
370                    return _portletLocalService.getPortlets(companyId, showSystem,
371                            showPortal);
372            }
373    
374            public java.util.List<com.liferay.portal.model.Portlet> getScopablePortlets() {
375                    return _portletLocalService.getScopablePortlets();
376            }
377    
378            public com.liferay.portal.model.PortletCategory getWARDisplay(
379                    java.lang.String servletContextName, java.lang.String xml)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return _portletLocalService.getWARDisplay(servletContextName, xml);
382            }
383    
384            public boolean hasPortlet(long companyId, java.lang.String portletId)
385                    throws com.liferay.portal.kernel.exception.SystemException {
386                    return _portletLocalService.hasPortlet(companyId, portletId);
387            }
388    
389            public void initEAR(javax.servlet.ServletContext servletContext,
390                    java.lang.String[] xmls,
391                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
392                    _portletLocalService.initEAR(servletContext, xmls, pluginPackage);
393            }
394    
395            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
396                    java.lang.String servletContextName,
397                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
398                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
399                    return _portletLocalService.initWAR(servletContextName, servletContext,
400                            xmls, pluginPackage);
401            }
402    
403            public java.util.Map<java.lang.String, com.liferay.portal.model.Portlet> loadGetPortletsPool(
404                    long companyId)
405                    throws com.liferay.portal.kernel.exception.SystemException {
406                    return _portletLocalService.loadGetPortletsPool(companyId);
407            }
408    
409            public void removeCompanyPortletsPool(long companyId) {
410                    _portletLocalService.removeCompanyPortletsPool(companyId);
411            }
412    
413            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
414                    java.lang.String portletId, java.lang.String roles, boolean active)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return _portletLocalService.updatePortlet(companyId, portletId, roles,
417                            active);
418            }
419    
420            /**
421             * @deprecated Renamed to {@link #getWrappedService}
422             */
423            public PortletLocalService getWrappedPortletLocalService() {
424                    return _portletLocalService;
425            }
426    
427            /**
428             * @deprecated Renamed to {@link #setWrappedService}
429             */
430            public void setWrappedPortletLocalService(
431                    PortletLocalService portletLocalService) {
432                    _portletLocalService = portletLocalService;
433            }
434    
435            public PortletLocalService getWrappedService() {
436                    return _portletLocalService;
437            }
438    
439            public void setWrappedService(PortletLocalService portletLocalService) {
440                    _portletLocalService = portletLocalService;
441            }
442    
443            private PortletLocalService _portletLocalService;
444    }