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