1   /**
2    * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
3    *
4    * This library is free software; you can redistribute it and/or modify it under
5    * the terms of the GNU Lesser General Public License as published by the Free
6    * Software Foundation; either version 2.1 of the License, or (at your option)
7    * any later version.
8    *
9    * This library is distributed in the hope that it will be useful, but WITHOUT
10   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11   * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12   * details.
13   */
14  
15  package com.liferay.portal.service;
16  
17  import com.liferay.portal.kernel.annotation.Isolation;
18  import com.liferay.portal.kernel.annotation.Propagation;
19  import com.liferay.portal.kernel.annotation.Transactional;
20  import com.liferay.portal.kernel.exception.PortalException;
21  import com.liferay.portal.kernel.exception.SystemException;
22  
23  /**
24   * <a href="PortletLocalService.java.html"><b><i>View Source</i></b></a>
25   *
26   * <p>
27   * ServiceBuilder generated this class. Modifications in this class will be
28   * overwritten the next time is generated.
29   * </p>
30   *
31   * <p>
32   * This interface defines the service. The default implementation is
33   * {@link
34   * com.liferay.portal.service.impl.PortletLocalServiceImpl}}.
35   * Modify methods in that class and rerun ServiceBuilder to populate this class
36   * and all other generated classes.
37   * </p>
38   *
39   * <p>
40   * 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.
41   * </p>
42   *
43   * @author    Brian Wing Shun Chan
44   * @see       PortletLocalServiceUtil
45   * @generated
46   */
47  @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
48      PortalException.class, SystemException.class})
49  public interface PortletLocalService {
50      public com.liferay.portal.model.Portlet addPortlet(
51          com.liferay.portal.model.Portlet portlet)
52          throws com.liferay.portal.kernel.exception.SystemException;
53  
54      public com.liferay.portal.model.Portlet createPortlet(long id);
55  
56      public void deletePortlet(long id)
57          throws com.liferay.portal.kernel.exception.PortalException,
58              com.liferay.portal.kernel.exception.SystemException;
59  
60      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
61          throws com.liferay.portal.kernel.exception.SystemException;
62  
63      @SuppressWarnings("unchecked")
64      public java.util.List dynamicQuery(
65          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
66          throws com.liferay.portal.kernel.exception.SystemException;
67  
68      @SuppressWarnings("unchecked")
69      public java.util.List dynamicQuery(
70          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
71          int end) throws com.liferay.portal.kernel.exception.SystemException;
72  
73      @SuppressWarnings("unchecked")
74      public java.util.List dynamicQuery(
75          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
76          int end,
77          com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
78          throws com.liferay.portal.kernel.exception.SystemException;
79  
80      public long dynamicQueryCount(
81          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
82          throws com.liferay.portal.kernel.exception.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public com.liferay.portal.model.Portlet getPortlet(long id)
86          throws com.liferay.portal.kernel.exception.PortalException,
87              com.liferay.portal.kernel.exception.SystemException;
88  
89      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
90      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
91          int start, int end)
92          throws com.liferay.portal.kernel.exception.SystemException;
93  
94      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
95      public int getPortletsCount()
96          throws com.liferay.portal.kernel.exception.SystemException;
97  
98      public com.liferay.portal.model.Portlet updatePortlet(
99          com.liferay.portal.model.Portlet portlet)
100         throws com.liferay.portal.kernel.exception.SystemException;
101 
102     public com.liferay.portal.model.Portlet updatePortlet(
103         com.liferay.portal.model.Portlet portlet, boolean merge)
104         throws com.liferay.portal.kernel.exception.SystemException;
105 
106     public void checkPortlet(com.liferay.portal.model.Portlet portlet)
107         throws com.liferay.portal.kernel.exception.PortalException,
108             com.liferay.portal.kernel.exception.SystemException;
109 
110     public void checkPortlets(long companyId)
111         throws com.liferay.portal.kernel.exception.PortalException,
112             com.liferay.portal.kernel.exception.SystemException;
113 
114     public void clearCache();
115 
116     public com.liferay.portal.model.Portlet clonePortlet(long companyId,
117         java.lang.String portletId)
118         throws com.liferay.portal.kernel.exception.SystemException;
119 
120     public com.liferay.portal.model.Portlet deployRemotePortlet(
121         com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
122         throws com.liferay.portal.kernel.exception.SystemException;
123 
124     public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
125 
126     public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
127 
128     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
129     public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays();
130 
131     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
132     public com.liferay.portal.model.PortletCategory getEARDisplay(
133         java.lang.String xml)
134         throws com.liferay.portal.kernel.exception.SystemException;
135 
136     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137     public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
138 
139     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
141 
142     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
143     public com.liferay.portal.model.PortletApp getPortletApp(
144         java.lang.String servletContextName);
145 
146     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
147     public com.liferay.portal.model.Portlet getPortletById(long companyId,
148         java.lang.String portletId)
149         throws com.liferay.portal.kernel.exception.SystemException;
150 
151     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
152     public com.liferay.portal.model.Portlet getPortletById(
153         java.lang.String portletId);
154 
155     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
156     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
157         long companyId, java.lang.String strutsPath)
158         throws com.liferay.portal.kernel.exception.SystemException;
159 
160     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
161     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
162 
163     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
165         long companyId)
166         throws com.liferay.portal.kernel.exception.SystemException;
167 
168     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
169     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
170         long companyId, boolean showSystem, boolean showPortal)
171         throws com.liferay.portal.kernel.exception.SystemException;
172 
173     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174     public com.liferay.portal.model.PortletCategory getWARDisplay(
175         java.lang.String servletContextName, java.lang.String xml)
176         throws com.liferay.portal.kernel.exception.SystemException;
177 
178     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179     public boolean hasPortlet(long companyId, java.lang.String portletId)
180         throws com.liferay.portal.kernel.exception.SystemException;
181 
182     public void initEAR(javax.servlet.ServletContext servletContext,
183         java.lang.String[] xmls,
184         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
185 
186     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
187         java.lang.String servletContextName,
188         javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
189         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
190 
191     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
192         java.lang.String portletId, java.lang.String roles, boolean active)
193         throws com.liferay.portal.kernel.exception.SystemException;
194 }