1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * The contents of this file are subject to the terms of the Liferay Enterprise
5    * Subscription License ("License"). You may not use this file except in
6    * compliance with the License. You can obtain a copy of the License by
7    * contacting Liferay, Inc. See the License for the specific language governing
8    * permissions and limitations under the License, including but not limited to
9    * distribution rights of the Software.
10   *
11   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
12   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
13   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
14   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
15   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
17   * SOFTWARE.
18   */
19  
20  package com.liferay.portal.service;
21  
22  import com.liferay.portal.PortalException;
23  import com.liferay.portal.SystemException;
24  import com.liferay.portal.kernel.annotation.Isolation;
25  import com.liferay.portal.kernel.annotation.Propagation;
26  import com.liferay.portal.kernel.annotation.Transactional;
27  
28  /**
29   * <a href="PortletLocalService.java.html"><b><i>View Source</i></b></a>
30   *
31   * <p>
32   * ServiceBuilder generated this class. Modifications in this class will be
33   * overwritten the next time is generated.
34   * </p>
35   *
36   * <p>
37   * This interface defines the service. The default implementation is
38   * <code>com.liferay.portal.service.impl.PortletLocalServiceImpl</code>.
39   * Modify methods in that class and rerun ServiceBuilder to populate this class
40   * and all other generated classes.
41   * </p>
42   *
43   * <p>
44   * 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.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.PortletLocalServiceUtil
50   *
51   */
52  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
53      PortalException.class, SystemException.class})
54  public interface PortletLocalService {
55      public com.liferay.portal.model.Portlet addPortlet(
56          com.liferay.portal.model.Portlet portlet)
57          throws com.liferay.portal.SystemException;
58  
59      public com.liferay.portal.model.Portlet createPortlet(long id);
60  
61      public void deletePortlet(long id)
62          throws com.liferay.portal.SystemException,
63              com.liferay.portal.PortalException;
64  
65      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<Object> dynamicQuery(
69          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
70          throws com.liferay.portal.SystemException;
71  
72      public java.util.List<Object> dynamicQuery(
73          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
74          int end) throws com.liferay.portal.SystemException;
75  
76      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
77      public com.liferay.portal.model.Portlet getPortlet(long id)
78          throws com.liferay.portal.SystemException,
79              com.liferay.portal.PortalException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
83          int start, int end) throws com.liferay.portal.SystemException;
84  
85      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
86      public int getPortletsCount() throws com.liferay.portal.SystemException;
87  
88      public com.liferay.portal.model.Portlet updatePortlet(
89          com.liferay.portal.model.Portlet portlet)
90          throws com.liferay.portal.SystemException;
91  
92      public com.liferay.portal.model.Portlet updatePortlet(
93          com.liferay.portal.model.Portlet portlet, boolean merge)
94          throws com.liferay.portal.SystemException;
95  
96      public com.liferay.portal.model.Portlet deployRemotePortlet(
97          com.liferay.portal.model.Portlet portlet);
98  
99      public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
100 
101     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
102     public com.liferay.portal.model.PortletCategory getEARDisplay(
103         java.lang.String xml) throws com.liferay.portal.SystemException;
104 
105     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106     public com.liferay.portal.model.PortletCategory getWARDisplay(
107         java.lang.String servletContextName, java.lang.String xml)
108         throws com.liferay.portal.SystemException;
109 
110     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
111     public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
112 
113     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
114     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
115 
116     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
117     public com.liferay.portal.model.Portlet getPortletById(
118         java.lang.String portletId);
119 
120     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
121     public com.liferay.portal.model.Portlet getPortletById(long companyId,
122         java.lang.String portletId) throws com.liferay.portal.SystemException;
123 
124     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
126         long companyId, java.lang.String strutsPath)
127         throws com.liferay.portal.SystemException;
128 
129     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
131 
132     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
134         long companyId) throws com.liferay.portal.SystemException;
135 
136     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
138         long companyId, boolean showSystem, boolean showPortal)
139         throws com.liferay.portal.SystemException;
140 
141     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142     public boolean hasPortlet(long companyId, java.lang.String portletId)
143         throws com.liferay.portal.SystemException;
144 
145     public void initEAR(javax.servlet.ServletContext servletContext,
146         java.lang.String[] xmls,
147         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
148 
149     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
150         java.lang.String servletContextName,
151         javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
152         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
153 
154     public com.liferay.portal.model.Portlet newPortlet(long companyId,
155         java.lang.String portletId);
156 
157     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
158         java.lang.String portletId, java.lang.String roles, boolean active)
159         throws com.liferay.portal.SystemException;
160 }