001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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            public PortletLocalServiceWrapper(PortletLocalService portletLocalService) {
028                    _portletLocalService = portletLocalService;
029            }
030    
031            /**
032            * Adds the portlet to the database. Also notifies the appropriate model listeners.
033            *
034            * @param portlet the portlet
035            * @return the portlet that was added
036            * @throws SystemException if a system exception occurred
037            */
038            public com.liferay.portal.model.Portlet addPortlet(
039                    com.liferay.portal.model.Portlet portlet)
040                    throws com.liferay.portal.kernel.exception.SystemException {
041                    return _portletLocalService.addPortlet(portlet);
042            }
043    
044            /**
045            * Creates a new portlet with the primary key. Does not add the portlet to the database.
046            *
047            * @param id the primary key for the new portlet
048            * @return the new portlet
049            */
050            public com.liferay.portal.model.Portlet createPortlet(long id) {
051                    return _portletLocalService.createPortlet(id);
052            }
053    
054            /**
055            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
056            *
057            * @param id the primary key of the portlet
058            * @throws PortalException if a portlet with the primary key could not be found
059            * @throws SystemException if a system exception occurred
060            */
061            public void deletePortlet(long id)
062                    throws com.liferay.portal.kernel.exception.PortalException,
063                            com.liferay.portal.kernel.exception.SystemException {
064                    _portletLocalService.deletePortlet(id);
065            }
066    
067            /**
068            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
069            *
070            * @param portlet the portlet
071            * @throws SystemException if a system exception occurred
072            */
073            public void deletePortlet(com.liferay.portal.model.Portlet portlet)
074                    throws com.liferay.portal.kernel.exception.SystemException {
075                    _portletLocalService.deletePortlet(portlet);
076            }
077    
078            /**
079            * Performs a dynamic query on the database and returns the matching rows.
080            *
081            * @param dynamicQuery the dynamic query
082            * @return the matching rows
083            * @throws SystemException if a system exception occurred
084            */
085            @SuppressWarnings("rawtypes")
086            public java.util.List dynamicQuery(
087                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
088                    throws com.liferay.portal.kernel.exception.SystemException {
089                    return _portletLocalService.dynamicQuery(dynamicQuery);
090            }
091    
092            /**
093            * Performs a dynamic query on the database and returns a range of the matching rows.
094            *
095            * <p>
096            * 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.
097            * </p>
098            *
099            * @param dynamicQuery the dynamic query
100            * @param start the lower bound of the range of model instances
101            * @param end the upper bound of the range of model instances (not inclusive)
102            * @return the range of matching rows
103            * @throws SystemException if a system exception occurred
104            */
105            @SuppressWarnings("rawtypes")
106            public java.util.List dynamicQuery(
107                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
108                    int end) throws com.liferay.portal.kernel.exception.SystemException {
109                    return _portletLocalService.dynamicQuery(dynamicQuery, start, end);
110            }
111    
112            /**
113            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
114            *
115            * <p>
116            * 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.
117            * </p>
118            *
119            * @param dynamicQuery the dynamic query
120            * @param start the lower bound of the range of model instances
121            * @param end the upper bound of the range of model instances (not inclusive)
122            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
123            * @return the ordered range of matching rows
124            * @throws SystemException if a system exception occurred
125            */
126            @SuppressWarnings("rawtypes")
127            public java.util.List dynamicQuery(
128                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129                    int end,
130                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
131                    throws com.liferay.portal.kernel.exception.SystemException {
132                    return _portletLocalService.dynamicQuery(dynamicQuery, start, end,
133                            orderByComparator);
134            }
135    
136            /**
137            * Returns the number of rows that match the dynamic query.
138            *
139            * @param dynamicQuery the dynamic query
140            * @return the number of rows that match the dynamic query
141            * @throws SystemException if a system exception occurred
142            */
143            public long dynamicQueryCount(
144                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
145                    throws com.liferay.portal.kernel.exception.SystemException {
146                    return _portletLocalService.dynamicQueryCount(dynamicQuery);
147            }
148    
149            /**
150            * Returns the portlet with the primary key.
151            *
152            * @param id the primary key of the portlet
153            * @return the portlet
154            * @throws PortalException if a portlet with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            public com.liferay.portal.model.Portlet getPortlet(long id)
158                    throws com.liferay.portal.kernel.exception.PortalException,
159                            com.liferay.portal.kernel.exception.SystemException {
160                    return _portletLocalService.getPortlet(id);
161            }
162    
163            public com.liferay.portal.model.PersistedModel getPersistedModel(
164                    java.io.Serializable primaryKeyObj)
165                    throws com.liferay.portal.kernel.exception.PortalException,
166                            com.liferay.portal.kernel.exception.SystemException {
167                    return _portletLocalService.getPersistedModel(primaryKeyObj);
168            }
169    
170            /**
171            * Returns a range of all the portlets.
172            *
173            * <p>
174            * 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.
175            * </p>
176            *
177            * @param start the lower bound of the range of portlets
178            * @param end the upper bound of the range of portlets (not inclusive)
179            * @return the range of portlets
180            * @throws SystemException if a system exception occurred
181            */
182            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
183                    int start, int end)
184                    throws com.liferay.portal.kernel.exception.SystemException {
185                    return _portletLocalService.getPortlets(start, end);
186            }
187    
188            /**
189            * Returns the number of portlets.
190            *
191            * @return the number of portlets
192            * @throws SystemException if a system exception occurred
193            */
194            public int getPortletsCount()
195                    throws com.liferay.portal.kernel.exception.SystemException {
196                    return _portletLocalService.getPortletsCount();
197            }
198    
199            /**
200            * Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
201            *
202            * @param portlet the portlet
203            * @return the portlet that was updated
204            * @throws SystemException if a system exception occurred
205            */
206            public com.liferay.portal.model.Portlet updatePortlet(
207                    com.liferay.portal.model.Portlet portlet)
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return _portletLocalService.updatePortlet(portlet);
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            * @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.
217            * @return the portlet that was updated
218            * @throws SystemException if a system exception occurred
219            */
220            public com.liferay.portal.model.Portlet updatePortlet(
221                    com.liferay.portal.model.Portlet portlet, boolean merge)
222                    throws com.liferay.portal.kernel.exception.SystemException {
223                    return _portletLocalService.updatePortlet(portlet, merge);
224            }
225    
226            /**
227            * Returns the Spring bean ID for this bean.
228            *
229            * @return the Spring bean ID for this bean
230            */
231            public java.lang.String getBeanIdentifier() {
232                    return _portletLocalService.getBeanIdentifier();
233            }
234    
235            /**
236            * Sets the Spring bean ID for this bean.
237            *
238            * @param beanIdentifier the Spring bean ID for this bean
239            */
240            public void setBeanIdentifier(java.lang.String beanIdentifier) {
241                    _portletLocalService.setBeanIdentifier(beanIdentifier);
242            }
243    
244            public void addPortletCategory(long companyId, java.lang.String categoryName) {
245                    _portletLocalService.addPortletCategory(companyId, categoryName);
246            }
247    
248            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
249                    throws com.liferay.portal.kernel.exception.PortalException,
250                            com.liferay.portal.kernel.exception.SystemException {
251                    _portletLocalService.checkPortlet(portlet);
252            }
253    
254            public void checkPortlets(long companyId)
255                    throws com.liferay.portal.kernel.exception.PortalException,
256                            com.liferay.portal.kernel.exception.SystemException {
257                    _portletLocalService.checkPortlets(companyId);
258            }
259    
260            public void clearCache() {
261                    _portletLocalService.clearCache();
262            }
263    
264            /**
265            * @deprecated {@link #clonePortlet(String)}
266            */
267            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
268                    java.lang.String portletId) {
269                    return _portletLocalService.clonePortlet(companyId, portletId);
270            }
271    
272            public com.liferay.portal.model.Portlet clonePortlet(
273                    java.lang.String portletId) {
274                    return _portletLocalService.clonePortlet(portletId);
275            }
276    
277            public com.liferay.portal.model.Portlet deployRemotePortlet(
278                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException {
281                    return _portletLocalService.deployRemotePortlet(portlet, categoryName);
282            }
283    
284            public com.liferay.portal.model.Portlet deployRemotePortlet(
285                    com.liferay.portal.model.Portlet portlet,
286                    java.lang.String[] categoryNames)
287                    throws com.liferay.portal.kernel.exception.PortalException,
288                            com.liferay.portal.kernel.exception.SystemException {
289                    return _portletLocalService.deployRemotePortlet(portlet, categoryNames);
290            }
291    
292            public void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
293                    _portletLocalService.destroyPortlet(portlet);
294            }
295    
296            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet) {
297                    _portletLocalService.destroyRemotePortlet(portlet);
298            }
299    
300            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays() {
301                    return _portletLocalService.getCustomAttributesDisplays();
302            }
303    
304            public com.liferay.portal.model.PortletCategory getEARDisplay(
305                    java.lang.String xml)
306                    throws com.liferay.portal.kernel.exception.SystemException {
307                    return _portletLocalService.getEARDisplay(xml);
308            }
309    
310            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets() {
311                    return _portletLocalService.getFriendlyURLMapperPortlets();
312            }
313    
314            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
315                    return _portletLocalService.getFriendlyURLMappers();
316            }
317    
318            public com.liferay.portal.model.PortletApp getPortletApp(
319                    java.lang.String servletContextName) {
320                    return _portletLocalService.getPortletApp(servletContextName);
321            }
322    
323            public com.liferay.portal.model.Portlet getPortletById(long companyId,
324                    java.lang.String portletId)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return _portletLocalService.getPortletById(companyId, portletId);
327            }
328    
329            public com.liferay.portal.model.Portlet getPortletById(
330                    java.lang.String portletId) {
331                    return _portletLocalService.getPortletById(portletId);
332            }
333    
334            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
335                    long companyId, java.lang.String strutsPath)
336                    throws com.liferay.portal.kernel.exception.SystemException {
337                    return _portletLocalService.getPortletByStrutsPath(companyId, strutsPath);
338            }
339    
340            public java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
341                    return _portletLocalService.getPortlets();
342            }
343    
344            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
345                    long companyId)
346                    throws com.liferay.portal.kernel.exception.SystemException {
347                    return _portletLocalService.getPortlets(companyId);
348            }
349    
350            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
351                    long companyId, boolean showSystem, boolean showPortal)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return _portletLocalService.getPortlets(companyId, showSystem,
354                            showPortal);
355            }
356    
357            public com.liferay.portal.model.PortletCategory getWARDisplay(
358                    java.lang.String servletContextName, java.lang.String xml)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return _portletLocalService.getWARDisplay(servletContextName, xml);
361            }
362    
363            public boolean hasPortlet(long companyId, java.lang.String portletId)
364                    throws com.liferay.portal.kernel.exception.SystemException {
365                    return _portletLocalService.hasPortlet(companyId, portletId);
366            }
367    
368            public void initEAR(javax.servlet.ServletContext servletContext,
369                    java.lang.String[] xmls,
370                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
371                    _portletLocalService.initEAR(servletContext, xmls, pluginPackage);
372            }
373    
374            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
375                    java.lang.String servletContextName,
376                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
377                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
378                    return _portletLocalService.initWAR(servletContextName, servletContext,
379                            xmls, pluginPackage);
380            }
381    
382            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
383                    java.lang.String portletId, java.lang.String roles, boolean active)
384                    throws com.liferay.portal.kernel.exception.SystemException {
385                    return _portletLocalService.updatePortlet(companyId, portletId, roles,
386                            active);
387            }
388    
389            public PortletLocalService getWrappedPortletLocalService() {
390                    return _portletLocalService;
391            }
392    
393            public void setWrappedPortletLocalService(
394                    PortletLocalService portletLocalService) {
395                    _portletLocalService = portletLocalService;
396            }
397    
398            private PortletLocalService _portletLocalService;
399    }