1   /**
2    * Copyright (c) 2000-2010 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   *
12   *
13   */
14  
15  package com.liferay.portal.service;
16  
17  import com.liferay.portal.PortalException;
18  import com.liferay.portal.SystemException;
19  import com.liferay.portal.kernel.annotation.Isolation;
20  import com.liferay.portal.kernel.annotation.Propagation;
21  import com.liferay.portal.kernel.annotation.Transactional;
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.SystemException;
53  
54      public com.liferay.portal.model.Portlet createPortlet(long id);
55  
56      public void deletePortlet(long id)
57          throws com.liferay.portal.PortalException,
58              com.liferay.portal.SystemException;
59  
60      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
61          throws com.liferay.portal.SystemException;
62  
63      @SuppressWarnings("rawtypes")
64      public java.util.List dynamicQuery(
65          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
66          throws com.liferay.portal.SystemException;
67  
68      @SuppressWarnings("rawtypes")
69      public java.util.List dynamicQuery(
70          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
71          int end) throws com.liferay.portal.SystemException;
72  
73      @SuppressWarnings("rawtypes")
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.SystemException;
79  
80      public int dynamicQueryCount(
81          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
82          throws com.liferay.portal.SystemException;
83  
84      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
85      public com.liferay.portal.model.Portlet getPortlet(long id)
86          throws com.liferay.portal.PortalException,
87              com.liferay.portal.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) throws com.liferay.portal.SystemException;
92  
93      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
94      public int getPortletsCount() throws com.liferay.portal.SystemException;
95  
96      public com.liferay.portal.model.Portlet updatePortlet(
97          com.liferay.portal.model.Portlet portlet)
98          throws com.liferay.portal.SystemException;
99  
100     public com.liferay.portal.model.Portlet updatePortlet(
101         com.liferay.portal.model.Portlet portlet, boolean merge)
102         throws com.liferay.portal.SystemException;
103 
104     public com.liferay.portal.model.Portlet clonePortlet(long companyId,
105         java.lang.String portletId) throws com.liferay.portal.SystemException;
106 
107     public com.liferay.portal.model.Portlet deployRemotePortlet(
108         com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
109         throws com.liferay.portal.SystemException;
110 
111     public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
112 
113     public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
114 
115     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
116     public com.liferay.portal.model.PortletCategory getEARDisplay(
117         java.lang.String xml) throws com.liferay.portal.SystemException;
118 
119     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
120     public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
121 
122     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
123     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
124 
125     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
126     public com.liferay.portal.model.PortletApp getPortletApp(
127         java.lang.String servletContextName);
128 
129     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130     public com.liferay.portal.model.Portlet getPortletById(long companyId,
131         java.lang.String portletId) throws com.liferay.portal.SystemException;
132 
133     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
134     public com.liferay.portal.model.Portlet getPortletById(
135         java.lang.String portletId);
136 
137     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
138     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
139         long companyId, java.lang.String strutsPath)
140         throws com.liferay.portal.SystemException;
141 
142     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
143     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
144 
145     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
146     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
147         long companyId) throws com.liferay.portal.SystemException;
148 
149     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
151         long companyId, boolean showSystem, boolean showPortal)
152         throws com.liferay.portal.SystemException;
153 
154     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155     public com.liferay.portal.model.PortletCategory getWARDisplay(
156         java.lang.String servletContextName, java.lang.String xml)
157         throws com.liferay.portal.SystemException;
158 
159     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160     public boolean hasPortlet(long companyId, java.lang.String portletId)
161         throws com.liferay.portal.SystemException;
162 
163     public void initEAR(javax.servlet.ServletContext servletContext,
164         java.lang.String[] xmls,
165         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
166 
167     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
168         java.lang.String servletContextName,
169         javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
170         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
171 
172     /**
173     * @deprecated {@link #clonePortlet(long, String)}
174     */
175     public com.liferay.portal.model.Portlet newPortlet(long companyId,
176         java.lang.String portletId);
177 
178     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
179         java.lang.String portletId, java.lang.String roles, boolean active)
180         throws com.liferay.portal.SystemException;
181 }