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