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    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    
026    /**
027     * Provides the local service interface for Portlet. Methods of this
028     * service will not have security checks based on the propagated JAAS
029     * credentials because this service can only be accessed from within the same
030     * VM.
031     *
032     * @author Brian Wing Shun Chan
033     * @see PortletLocalServiceUtil
034     * @see com.liferay.portal.service.base.PortletLocalServiceBaseImpl
035     * @see com.liferay.portal.service.impl.PortletLocalServiceImpl
036     * @generated
037     */
038    @ProviderType
039    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
040            PortalException.class, SystemException.class})
041    public interface PortletLocalService extends BaseLocalService,
042            PersistedModelLocalService {
043            /*
044             * NOTE FOR DEVELOPERS:
045             *
046             * Never modify or reference this interface directly. Always use {@link PortletLocalServiceUtil} to access the portlet local service. Add custom service methods to {@link com.liferay.portal.service.impl.PortletLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
047             */
048    
049            /**
050            * Adds the portlet to the database. Also notifies the appropriate model listeners.
051            *
052            * @param portlet the portlet
053            * @return the portlet that was added
054            * @throws SystemException if a system exception occurred
055            */
056            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
057            public com.liferay.portal.model.Portlet addPortlet(
058                    com.liferay.portal.model.Portlet portlet)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            /**
062            * Creates a new portlet with the primary key. Does not add the portlet to the database.
063            *
064            * @param id the primary key for the new portlet
065            * @return the new portlet
066            */
067            public com.liferay.portal.model.Portlet createPortlet(long id);
068    
069            /**
070            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
071            *
072            * @param id the primary key of the portlet
073            * @return the portlet that was removed
074            * @throws PortalException if a portlet with the primary key could not be found
075            * @throws SystemException if a system exception occurred
076            */
077            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
078            public com.liferay.portal.model.Portlet deletePortlet(long id)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            /**
083            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
084            *
085            * @param portlet the portlet
086            * @return the portlet that was removed
087            * @throws SystemException if a system exception occurred
088            */
089            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
090            public com.liferay.portal.model.Portlet deletePortlet(
091                    com.liferay.portal.model.Portlet portlet)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
095    
096            /**
097            * Performs a dynamic query on the database and returns the matching rows.
098            *
099            * @param dynamicQuery the dynamic query
100            * @return the matching rows
101            * @throws SystemException if a system exception occurred
102            */
103            @SuppressWarnings("rawtypes")
104            public java.util.List dynamicQuery(
105                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
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    
126            /**
127            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
128            *
129            * <p>
130            * 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.
131            * </p>
132            *
133            * @param dynamicQuery the dynamic query
134            * @param start the lower bound of the range of model instances
135            * @param end the upper bound of the range of model instances (not inclusive)
136            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
137            * @return the ordered range of matching rows
138            * @throws SystemException if a system exception occurred
139            */
140            @SuppressWarnings("rawtypes")
141            public java.util.List dynamicQuery(
142                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
143                    int end,
144                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
145                    throws com.liferay.portal.kernel.exception.SystemException;
146    
147            /**
148            * Returns the number of rows that match the dynamic query.
149            *
150            * @param dynamicQuery the dynamic query
151            * @return the number of rows that match the dynamic query
152            * @throws SystemException if a system exception occurred
153            */
154            public long dynamicQueryCount(
155                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows that match the dynamic query
164            * @throws SystemException if a system exception occurred
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public com.liferay.portal.model.Portlet fetchPortlet(long id)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns the portlet with the primary key.
177            *
178            * @param id the primary key of the portlet
179            * @return the portlet
180            * @throws PortalException if a portlet with the primary key could not be found
181            * @throws SystemException if a system exception occurred
182            */
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portal.model.Portlet getPortlet(long id)
185                    throws com.liferay.portal.kernel.exception.PortalException,
186                            com.liferay.portal.kernel.exception.SystemException;
187    
188            @Override
189            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
190            public com.liferay.portal.model.PersistedModel getPersistedModel(
191                    java.io.Serializable primaryKeyObj)
192                    throws com.liferay.portal.kernel.exception.PortalException,
193                            com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Returns a range of all the portlets.
197            *
198            * <p>
199            * 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.
200            * </p>
201            *
202            * @param start the lower bound of the range of portlets
203            * @param end the upper bound of the range of portlets (not inclusive)
204            * @return the range of portlets
205            * @throws SystemException if a system exception occurred
206            */
207            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
208            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
209                    int start, int end)
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Returns the number of portlets.
214            *
215            * @return the number of portlets
216            * @throws SystemException if a system exception occurred
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public int getPortletsCount()
220                    throws com.liferay.portal.kernel.exception.SystemException;
221    
222            /**
223            * Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
224            *
225            * @param portlet the portlet
226            * @return the portlet that was updated
227            * @throws SystemException if a system exception occurred
228            */
229            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
230            public com.liferay.portal.model.Portlet updatePortlet(
231                    com.liferay.portal.model.Portlet portlet)
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            /**
235            * Returns the Spring bean ID for this bean.
236            *
237            * @return the Spring bean ID for this bean
238            */
239            public java.lang.String getBeanIdentifier();
240    
241            /**
242            * Sets the Spring bean ID for this bean.
243            *
244            * @param beanIdentifier the Spring bean ID for this bean
245            */
246            public void setBeanIdentifier(java.lang.String beanIdentifier);
247    
248            @com.liferay.portal.kernel.spring.aop.Skip
249            public void addPortletCategory(long companyId, java.lang.String categoryName);
250    
251            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
252                    throws com.liferay.portal.kernel.exception.PortalException,
253                            com.liferay.portal.kernel.exception.SystemException;
254    
255            public void checkPortlets(long companyId)
256                    throws com.liferay.portal.kernel.exception.PortalException,
257                            com.liferay.portal.kernel.exception.SystemException;
258    
259            @com.liferay.portal.kernel.spring.aop.Skip
260            public void clearCache();
261    
262            @com.liferay.portal.kernel.cluster.Clusterable
263            @com.liferay.portal.kernel.transaction.Transactional(enabled = false)
264            public void clearCompanyPortletsPool();
265    
266            /**
267            * @deprecated As of 6.1.0, replaced by {@link #clonePortlet(String)}
268            */
269            @com.liferay.portal.kernel.spring.aop.Skip
270            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
271                    java.lang.String portletId);
272    
273            @com.liferay.portal.kernel.spring.aop.Skip
274            public com.liferay.portal.model.Portlet clonePortlet(
275                    java.lang.String portletId);
276    
277            public void deletePortlet(long companyId, java.lang.String portletId,
278                    long plid)
279                    throws com.liferay.portal.kernel.exception.PortalException,
280                            com.liferay.portal.kernel.exception.SystemException;
281    
282            public void deletePortlets(long companyId, java.lang.String[] portletIds,
283                    long plid)
284                    throws com.liferay.portal.kernel.exception.PortalException,
285                            com.liferay.portal.kernel.exception.SystemException;
286    
287            public com.liferay.portal.model.Portlet deployRemotePortlet(
288                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
289                    throws com.liferay.portal.kernel.exception.PortalException,
290                            com.liferay.portal.kernel.exception.SystemException;
291    
292            public com.liferay.portal.model.Portlet deployRemotePortlet(
293                    com.liferay.portal.model.Portlet portlet,
294                    java.lang.String[] categoryNames)
295                    throws com.liferay.portal.kernel.exception.PortalException,
296                            com.liferay.portal.kernel.exception.SystemException;
297    
298            @com.liferay.portal.kernel.spring.aop.Skip
299            public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
300    
301            @com.liferay.portal.kernel.spring.aop.Skip
302            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
303    
304            @com.liferay.portal.kernel.spring.aop.Skip
305            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
306            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays();
307    
308            @com.liferay.portal.kernel.spring.aop.Skip
309            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
310            public com.liferay.portal.model.PortletCategory getEARDisplay(
311                    java.lang.String xml)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            @com.liferay.portal.kernel.spring.aop.Skip
315            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
316            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
317    
318            @com.liferay.portal.kernel.spring.aop.Skip
319            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
320            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
321    
322            @com.liferay.portal.kernel.spring.aop.Skip
323            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
324            public com.liferay.portal.model.PortletApp getPortletApp(
325                    java.lang.String servletContextName);
326    
327            @com.liferay.portal.kernel.spring.aop.Skip
328            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
329            public com.liferay.portal.model.Portlet getPortletById(long companyId,
330                    java.lang.String portletId)
331                    throws com.liferay.portal.kernel.exception.SystemException;
332    
333            @com.liferay.portal.kernel.spring.aop.Skip
334            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
335            public com.liferay.portal.model.Portlet getPortletById(
336                    java.lang.String portletId);
337    
338            @com.liferay.portal.kernel.spring.aop.Skip
339            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
340            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
341                    long companyId, java.lang.String strutsPath)
342                    throws com.liferay.portal.kernel.exception.SystemException;
343    
344            @com.liferay.portal.kernel.spring.aop.Skip
345            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
346            public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
347    
348            @com.liferay.portal.kernel.spring.aop.Skip
349            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
350            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
351                    long companyId)
352                    throws com.liferay.portal.kernel.exception.SystemException;
353    
354            @com.liferay.portal.kernel.spring.aop.Skip
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
357                    long companyId, boolean showSystem, boolean showPortal)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            @com.liferay.portal.kernel.spring.aop.Skip
361            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
362            public java.util.List<com.liferay.portal.model.Portlet> getScopablePortlets();
363    
364            @com.liferay.portal.kernel.spring.aop.Skip
365            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
366            public com.liferay.portal.model.PortletCategory getWARDisplay(
367                    java.lang.String servletContextName, java.lang.String xml)
368                    throws com.liferay.portal.kernel.exception.SystemException;
369    
370            @com.liferay.portal.kernel.spring.aop.Skip
371            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
372            public boolean hasPortlet(long companyId, java.lang.String portletId)
373                    throws com.liferay.portal.kernel.exception.SystemException;
374    
375            @com.liferay.portal.kernel.spring.aop.Skip
376            public void initEAR(javax.servlet.ServletContext servletContext,
377                    java.lang.String[] xmls,
378                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
379    
380            @com.liferay.portal.kernel.spring.aop.Skip
381            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
382                    java.lang.String servletContextName,
383                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
384                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
385    
386            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
387            public java.util.Map<java.lang.String, com.liferay.portal.model.Portlet> loadGetPortletsPool(
388                    long companyId)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            @com.liferay.portal.kernel.cluster.Clusterable
392            @com.liferay.portal.kernel.transaction.Transactional(enabled = false)
393            public void removeCompanyPortletsPool(long companyId);
394    
395            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
396                    java.lang.String portletId, java.lang.String roles, boolean active)
397                    throws com.liferay.portal.kernel.exception.SystemException;
398    }