001    /**
002     * Copyright (c) 2000-2010 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.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     * <p>
025     * This interface defines the service. The default implementation is
026     * {@link
027     * com.liferay.portal.service.impl.PortletLocalServiceImpl}.
028     * Modify methods in that class and rerun ServiceBuilder to populate this class
029     * and all other generated classes.
030     * </p>
031     *
032     * <p>
033     * 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.
034     * </p>
035     *
036     * @author    Brian Wing Shun Chan
037     * @see       PortletLocalServiceUtil
038     * @generated
039     */
040    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
041            PortalException.class, SystemException.class})
042    public interface PortletLocalService {
043            public com.liferay.portal.model.Portlet addPortlet(
044                    com.liferay.portal.model.Portlet portlet)
045                    throws com.liferay.portal.kernel.exception.SystemException;
046    
047            public com.liferay.portal.model.Portlet createPortlet(long id);
048    
049            public void deletePortlet(long id)
050                    throws com.liferay.portal.kernel.exception.PortalException,
051                            com.liferay.portal.kernel.exception.SystemException;
052    
053            public void deletePortlet(com.liferay.portal.model.Portlet portlet)
054                    throws com.liferay.portal.kernel.exception.SystemException;
055    
056            @SuppressWarnings("unchecked")
057            public java.util.List dynamicQuery(
058                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
059                    throws com.liferay.portal.kernel.exception.SystemException;
060    
061            @SuppressWarnings("unchecked")
062            public java.util.List dynamicQuery(
063                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
064                    int end) throws com.liferay.portal.kernel.exception.SystemException;
065    
066            @SuppressWarnings("unchecked")
067            public java.util.List dynamicQuery(
068                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
069                    int end,
070                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
071                    throws com.liferay.portal.kernel.exception.SystemException;
072    
073            public long dynamicQueryCount(
074                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
075                    throws com.liferay.portal.kernel.exception.SystemException;
076    
077            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
078            public com.liferay.portal.model.Portlet getPortlet(long id)
079                    throws com.liferay.portal.kernel.exception.PortalException,
080                            com.liferay.portal.kernel.exception.SystemException;
081    
082            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
083            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
084                    int start, int end)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
088            public int getPortletsCount()
089                    throws com.liferay.portal.kernel.exception.SystemException;
090    
091            public com.liferay.portal.model.Portlet updatePortlet(
092                    com.liferay.portal.model.Portlet portlet)
093                    throws com.liferay.portal.kernel.exception.SystemException;
094    
095            public com.liferay.portal.model.Portlet updatePortlet(
096                    com.liferay.portal.model.Portlet portlet, boolean merge)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            public void checkPortlet(com.liferay.portal.model.Portlet portlet)
100                    throws com.liferay.portal.kernel.exception.PortalException,
101                            com.liferay.portal.kernel.exception.SystemException;
102    
103            public void checkPortlets(long companyId)
104                    throws com.liferay.portal.kernel.exception.PortalException,
105                            com.liferay.portal.kernel.exception.SystemException;
106    
107            public void clearCache();
108    
109            public com.liferay.portal.model.Portlet clonePortlet(long companyId,
110                    java.lang.String portletId)
111                    throws com.liferay.portal.kernel.exception.SystemException;
112    
113            public com.liferay.portal.model.Portlet deployRemotePortlet(
114                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
115                    throws com.liferay.portal.kernel.exception.SystemException;
116    
117            public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
118    
119            public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
120    
121            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122            public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays();
123    
124            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125            public com.liferay.portal.model.PortletCategory getEARDisplay(
126                    java.lang.String xml)
127                    throws com.liferay.portal.kernel.exception.SystemException;
128    
129            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130            public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
131    
132            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133            public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
134    
135            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136            public com.liferay.portal.model.PortletApp getPortletApp(
137                    java.lang.String servletContextName);
138    
139            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140            public com.liferay.portal.model.Portlet getPortletById(long companyId,
141                    java.lang.String portletId)
142                    throws com.liferay.portal.kernel.exception.SystemException;
143    
144            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145            public com.liferay.portal.model.Portlet getPortletById(
146                    java.lang.String portletId);
147    
148            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
149            public com.liferay.portal.model.Portlet getPortletByStrutsPath(
150                    long companyId, java.lang.String strutsPath)
151                    throws com.liferay.portal.kernel.exception.SystemException;
152    
153            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
154            public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
155    
156            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
158                    long companyId)
159                    throws com.liferay.portal.kernel.exception.SystemException;
160    
161            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162            public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
163                    long companyId, boolean showSystem, boolean showPortal)
164                    throws com.liferay.portal.kernel.exception.SystemException;
165    
166            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167            public com.liferay.portal.model.PortletCategory getWARDisplay(
168                    java.lang.String servletContextName, java.lang.String xml)
169                    throws com.liferay.portal.kernel.exception.SystemException;
170    
171            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172            public boolean hasPortlet(long companyId, java.lang.String portletId)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            public void initEAR(javax.servlet.ServletContext servletContext,
176                    java.lang.String[] xmls,
177                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
178    
179            public java.util.List<com.liferay.portal.model.Portlet> initWAR(
180                    java.lang.String servletContextName,
181                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
182                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
183    
184            public com.liferay.portal.model.Portlet updatePortlet(long companyId,
185                    java.lang.String portletId, java.lang.String roles, boolean active)
186                    throws com.liferay.portal.kernel.exception.SystemException;
187    }