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      public java.util.List<Object> dynamicQuery(
64          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
65          throws com.liferay.portal.kernel.exception.SystemException;
66  
67      public java.util.List<Object> dynamicQuery(
68          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
69          int end) throws com.liferay.portal.kernel.exception.SystemException;
70  
71      public java.util.List<Object> dynamicQuery(
72          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
73          int end,
74          com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
75          throws com.liferay.portal.kernel.exception.SystemException;
76  
77      public int dynamicQueryCount(
78          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
79          throws com.liferay.portal.kernel.exception.SystemException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public com.liferay.portal.model.Portlet getPortlet(long id)
83          throws com.liferay.portal.kernel.exception.PortalException,
84              com.liferay.portal.kernel.exception.SystemException;
85  
86      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
87      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
88          int start, int end)
89          throws com.liferay.portal.kernel.exception.SystemException;
90  
91      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
92      public int getPortletsCount()
93          throws com.liferay.portal.kernel.exception.SystemException;
94  
95      public com.liferay.portal.model.Portlet updatePortlet(
96          com.liferay.portal.model.Portlet portlet)
97          throws com.liferay.portal.kernel.exception.SystemException;
98  
99      public com.liferay.portal.model.Portlet updatePortlet(
100         com.liferay.portal.model.Portlet portlet, boolean merge)
101         throws com.liferay.portal.kernel.exception.SystemException;
102 
103     public void checkPortlet(com.liferay.portal.model.Portlet portlet)
104         throws com.liferay.portal.kernel.exception.PortalException,
105             com.liferay.portal.kernel.exception.SystemException;
106 
107     public void checkPortlets(long companyId)
108         throws com.liferay.portal.kernel.exception.PortalException,
109             com.liferay.portal.kernel.exception.SystemException;
110 
111     public void clearCache();
112 
113     public com.liferay.portal.model.Portlet deployRemotePortlet(
114         com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
115         throws com.liferay.portal.kernel.exception.SystemException;
116 
117     public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
118 
119     public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
120 
121     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122     public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays();
123 
124     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
125     public com.liferay.portal.model.PortletCategory getEARDisplay(
126         java.lang.String xml)
127         throws com.liferay.portal.kernel.exception.SystemException;
128 
129     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130     public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
131 
132     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
134 
135     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136     public com.liferay.portal.model.PortletApp getPortletApp(
137         java.lang.String servletContextName);
138 
139     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
140     public com.liferay.portal.model.Portlet getPortletById(long companyId,
141         java.lang.String portletId)
142         throws com.liferay.portal.kernel.exception.SystemException;
143 
144     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
145     public com.liferay.portal.model.Portlet getPortletById(
146         java.lang.String portletId);
147 
148     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
149     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
150         long companyId, java.lang.String strutsPath)
151         throws com.liferay.portal.kernel.exception.SystemException;
152 
153     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
154     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
155 
156     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
157     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
158         long companyId)
159         throws com.liferay.portal.kernel.exception.SystemException;
160 
161     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
162     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
163         long companyId, boolean showSystem, boolean showPortal)
164         throws com.liferay.portal.kernel.exception.SystemException;
165 
166     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
167     public com.liferay.portal.model.PortletCategory getWARDisplay(
168         java.lang.String servletContextName, java.lang.String xml)
169         throws com.liferay.portal.kernel.exception.SystemException;
170 
171     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
172     public boolean hasPortlet(long companyId, java.lang.String portletId)
173         throws com.liferay.portal.kernel.exception.SystemException;
174 
175     public void initEAR(javax.servlet.ServletContext servletContext,
176         java.lang.String[] xmls,
177         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
178 
179     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
180         java.lang.String servletContextName,
181         javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
182         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
183 
184     public com.liferay.portal.model.Portlet clonePortlet(long companyId,
185         java.lang.String portletId)
186         throws com.liferay.portal.kernel.exception.SystemException;
187 
188     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
189         java.lang.String portletId, java.lang.String roles, boolean active)
190         throws com.liferay.portal.kernel.exception.SystemException;
191 }