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