001    /**
002     * Copyright (c) 2000-2010 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    import com.liferay.portal.kernel.annotation.Isolation;
018    import com.liferay.portal.kernel.annotation.Propagation;
019    import com.liferay.portal.kernel.annotation.Transactional;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.exception.SystemException;
022    
023    /**
024     * The interface for the portlet local service.
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * <p>
031     * 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.
032     * </p>
033     *
034     * @author Brian Wing Shun Chan
035     * @see PortletLocalServiceUtil
036     * @see com.liferay.portal.service.base.PortletLocalServiceBaseImpl
037     * @see com.liferay.portal.service.impl.PortletLocalServiceImpl
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface PortletLocalService {
043            /**
044            * Adds the portlet to the database. Also notifies the appropriate model listeners.
045            *
046            * @param portlet the portlet to add
047            * @return the portlet that was added
048            * @throws SystemException if a system exception occurred
049            */
050            public com.liferay.portal.model.Portlet addPortlet(
051                    com.liferay.portal.model.Portlet portlet)
052                    throws com.liferay.portal.kernel.exception.SystemException;
053    
054            /**
055            * Creates a new portlet with the primary key. Does not add the portlet to the database.
056            *
057            * @param id the primary key for the new portlet
058            * @return the new portlet
059            */
060            public com.liferay.portal.model.Portlet createPortlet(long id);
061    
062            /**
063            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
064            *
065            * @param id the primary key of the portlet to delete
066            * @throws PortalException if a portlet with the primary key could not be found
067            * @throws SystemException if a system exception occurred
068            */
069            public void deletePortlet(long id)
070                    throws com.liferay.portal.kernel.exception.PortalException,
071                            com.liferay.portal.kernel.exception.SystemException;
072    
073            /**
074            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
075            *
076            * @param portlet the portlet to delete
077            * @throws SystemException if a system exception occurred
078            */
079            public void deletePortlet(com.liferay.portal.model.Portlet portlet)
080                    throws com.liferay.portal.kernel.exception.SystemException;
081    
082            /**
083            * Performs a dynamic query on the database and returns the matching rows.
084            *
085            * @param dynamicQuery the dynamic query to search with
086            * @return the matching rows
087            * @throws SystemException if a system exception occurred
088            */
089            @SuppressWarnings("rawtypes")
090            public java.util.List dynamicQuery(
091                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
092                    throws com.liferay.portal.kernel.exception.SystemException;
093    
094            /**
095            * Performs a dynamic query on the database and returns a range of the matching rows.
096            *
097            * <p>
098            * 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.
099            * </p>
100            *
101            * @param dynamicQuery the dynamic query to search with
102            * @param start the lower bound of the range of model instances to return
103            * @param end the upper bound of the range of model instances to return (not inclusive)
104            * @return the range of matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
110                    int end) throws com.liferay.portal.kernel.exception.SystemException;
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 to search with
120            * @param start the lower bound of the range of model instances to return
121            * @param end the upper bound of the range of model instances to return (not inclusive)
122            * @param orderByComparator the comparator to order the results by
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    
133            /**
134            * Counts the number of rows that match the dynamic query.
135            *
136            * @param dynamicQuery the dynamic query to search with
137            * @return the number of rows that match the dynamic query
138            * @throws SystemException if a system exception occurred
139            */
140            public long dynamicQueryCount(
141                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            /**
145            * Gets the portlet with the primary key.
146            *
147            * @param id the primary key of the portlet to get
148            * @return the portlet
149            * @throws PortalException if a portlet with the primary key could not be found
150            * @throws SystemException if a system exception occurred
151            */
152            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
153            public com.liferay.portal.model.Portlet getPortlet(long id)
154                    throws com.liferay.portal.kernel.exception.PortalException,
155                            com.liferay.portal.kernel.exception.SystemException;
156    
157            /**
158            * Gets a range of all the portlets.
159            *
160            * <p>
161            * 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.
162            * </p>
163            *
164            * @param start the lower bound of the range of portlets to return
165            * @param end the upper bound of the range of portlets to return (not inclusive)
166            * @return the range of portlets
167            * @throws SystemException if a system exception occurred
168            */
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
171                    int start, int end)
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Gets the number of portlets.
176            *
177            * @return the number of portlets
178            * @throws SystemException if a system exception occurred
179            */
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public int getPortletsCount()
182                    throws com.liferay.portal.kernel.exception.SystemException;
183    
184            /**
185            * Updates the portlet in the database. Also notifies the appropriate model listeners.
186            *
187            * @param portlet the portlet to update
188            * @return the portlet that was updated
189            * @throws SystemException if a system exception occurred
190            */
191            public com.liferay.portal.model.Portlet updatePortlet(
192                    com.liferay.portal.model.Portlet portlet)
193                    throws com.liferay.portal.kernel.exception.SystemException;
194    
195            /**
196            * Updates the portlet in the database. Also notifies the appropriate model listeners.
197            *
198            * @param portlet the portlet to update
199            * @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.
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, boolean merge)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
208                    throws com.liferay.portal.kernel.exception.PortalException,
209                            com.liferay.portal.kernel.exception.SystemException;
210    
211            public void checkPortlets(long companyId)
212                    throws com.liferay.portal.kernel.exception.PortalException,
213                            com.liferay.portal.kernel.exception.SystemException;
214    
215            public void clearCache();
216    
217            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
218                    java.lang.String portletId)
219                    throws com.liferay.portal.kernel.exception.SystemException;
220    
221            public com.liferay.portal.model.Portlet deployRemotePortlet(
222                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
226    
227            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
228    
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays();
231    
232            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
233            public com.liferay.portal.model.PortletCategory getEARDisplay(
234                    java.lang.String xml)
235                    throws com.liferay.portal.kernel.exception.SystemException;
236    
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
239    
240            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
241            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
242    
243            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
244            public com.liferay.portal.model.PortletApp getPortletApp(
245                    java.lang.String servletContextName);
246    
247            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
248            public com.liferay.portal.model.Portlet getPortletById(long companyId,
249                    java.lang.String portletId)
250                    throws com.liferay.portal.kernel.exception.SystemException;
251    
252            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
253            public com.liferay.portal.model.Portlet getPortletById(
254                    java.lang.String portletId);
255    
256            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
257            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
258                    long companyId, java.lang.String strutsPath)
259                    throws com.liferay.portal.kernel.exception.SystemException;
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
263    
264            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
265            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
266                    long companyId)
267                    throws com.liferay.portal.kernel.exception.SystemException;
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
271                    long companyId, boolean showSystem, boolean showPortal)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
275            public com.liferay.portal.model.PortletCategory getWARDisplay(
276                    java.lang.String servletContextName, java.lang.String xml)
277                    throws com.liferay.portal.kernel.exception.SystemException;
278    
279            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
280            public boolean hasPortlet(long companyId, java.lang.String portletId)
281                    throws com.liferay.portal.kernel.exception.SystemException;
282    
283            public void initEAR(javax.servlet.ServletContext servletContext,
284                    java.lang.String[] xmls,
285                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
286    
287            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
288                    java.lang.String servletContextName,
289                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
290                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
291    
292            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
293                    java.lang.String portletId, java.lang.String roles, boolean active)
294                    throws com.liferay.portal.kernel.exception.SystemException;
295    }