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.Propagation;
25  import com.liferay.portal.kernel.annotation.Transactional;
26  
27  /**
28   * <a href="PortletLocalService.java.html"><b><i>View Source</i></b></a>
29   *
30   * <p>
31   * ServiceBuilder generated this class. Modifications in this class will be
32   * overwritten the next time is generated.
33   * </p>
34   *
35   * <p>
36   * This interface defines the service. The default implementation is
37   * <code>com.liferay.portal.service.impl.PortletLocalServiceImpl</code>.
38   * Modify methods in that class and rerun ServiceBuilder to populate this class
39   * and all other generated classes.
40   * </p>
41   *
42   * <p>
43   * 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.
44   * </p>
45   *
46   * @author Brian Wing Shun Chan
47   *
48   * @see com.liferay.portal.service.PortletLocalServiceUtil
49   *
50   */
51  @Transactional(rollbackFor =  {
52      PortalException.class, SystemException.class})
53  public interface PortletLocalService {
54      public com.liferay.portal.model.Portlet addPortlet(
55          com.liferay.portal.model.Portlet portlet)
56          throws com.liferay.portal.SystemException;
57  
58      public com.liferay.portal.model.Portlet createPortlet(long id);
59  
60      public void deletePortlet(long id)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
65          throws com.liferay.portal.SystemException;
66  
67      public java.util.List<Object> dynamicQuery(
68          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
69          throws com.liferay.portal.SystemException;
70  
71      public java.util.List<Object> dynamicQuery(
72          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
73          int end) throws com.liferay.portal.SystemException;
74  
75      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
76      public com.liferay.portal.model.Portlet getPortlet(long id)
77          throws com.liferay.portal.SystemException,
78              com.liferay.portal.PortalException;
79  
80      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
81      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
82          int start, int end) throws com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public int getPortletsCount() throws com.liferay.portal.SystemException;
86  
87      public com.liferay.portal.model.Portlet updatePortlet(
88          com.liferay.portal.model.Portlet portlet)
89          throws com.liferay.portal.SystemException;
90  
91      public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
92  
93      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
94      public com.liferay.portal.model.PortletCategory getEARDisplay(
95          java.lang.String xml) throws com.liferay.portal.SystemException;
96  
97      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
98      public com.liferay.portal.model.PortletCategory getWARDisplay(
99          java.lang.String servletContextName, java.lang.String xml)
100         throws com.liferay.portal.SystemException;
101 
102     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
103     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
104 
105     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
106     public com.liferay.portal.model.Portlet getPortletById(long companyId,
107         java.lang.String portletId) throws com.liferay.portal.SystemException;
108 
109     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
110     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
111         long companyId, java.lang.String strutsPath)
112         throws com.liferay.portal.SystemException;
113 
114     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
115     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
116 
117     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
118     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
119         long companyId) throws com.liferay.portal.SystemException;
120 
121     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
123         long companyId, boolean showSystem, boolean showPortal)
124         throws com.liferay.portal.SystemException;
125 
126     public boolean hasPortlet(long companyId, java.lang.String portletId)
127         throws com.liferay.portal.SystemException;
128 
129     public void initEAR(javax.servlet.ServletContext servletContext,
130         java.lang.String[] xmls,
131         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
132 
133     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
134         java.lang.String servletContextName,
135         javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
136         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
137 
138     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
139         java.lang.String portletId, java.lang.String roles, boolean active)
140         throws com.liferay.portal.SystemException;
141 }