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      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
72      public com.liferay.portal.model.Portlet getPortlet(long id)
73          throws com.liferay.portal.kernel.exception.PortalException,
74              com.liferay.portal.kernel.exception.SystemException;
75  
76      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
77      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
78          int start, int end)
79          throws com.liferay.portal.kernel.exception.SystemException;
80  
81      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
82      public int getPortletsCount()
83          throws com.liferay.portal.kernel.exception.SystemException;
84  
85      public com.liferay.portal.model.Portlet updatePortlet(
86          com.liferay.portal.model.Portlet portlet)
87          throws com.liferay.portal.kernel.exception.SystemException;
88  
89      public com.liferay.portal.model.Portlet updatePortlet(
90          com.liferay.portal.model.Portlet portlet, boolean merge)
91          throws com.liferay.portal.kernel.exception.SystemException;
92  
93      public void checkPortlet(com.liferay.portal.model.Portlet portlet)
94          throws com.liferay.portal.kernel.exception.PortalException,
95              com.liferay.portal.kernel.exception.SystemException;
96  
97      public void checkPortlets(long companyId)
98          throws com.liferay.portal.kernel.exception.PortalException,
99              com.liferay.portal.kernel.exception.SystemException;
100 
101     public com.liferay.portal.model.Portlet deployRemotePortlet(
102         com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
103         throws com.liferay.portal.kernel.exception.SystemException;
104 
105     public void destroyRemotePortlet(com.liferay.portal.model.Portlet portlet);
106 
107     public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
108 
109     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
110     public java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays();
111 
112     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
113     public com.liferay.portal.model.PortletCategory getEARDisplay(
114         java.lang.String xml)
115         throws com.liferay.portal.kernel.exception.SystemException;
116 
117     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
118     public com.liferay.portal.model.PortletApp getPortletApp(
119         java.lang.String servletContextName);
120 
121     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
122     public com.liferay.portal.model.PortletCategory getWARDisplay(
123         java.lang.String servletContextName, java.lang.String xml)
124         throws com.liferay.portal.kernel.exception.SystemException;
125 
126     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
127     public java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets();
128 
129     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
130     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
131 
132     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
133     public com.liferay.portal.model.Portlet getPortletById(
134         java.lang.String portletId);
135 
136     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
137     public com.liferay.portal.model.Portlet getPortletById(long companyId,
138         java.lang.String portletId)
139         throws com.liferay.portal.kernel.exception.SystemException;
140 
141     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
143         long companyId, java.lang.String strutsPath)
144         throws com.liferay.portal.kernel.exception.SystemException;
145 
146     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
147     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
148 
149     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
150     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
151         long companyId)
152         throws com.liferay.portal.kernel.exception.SystemException;
153 
154     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
155     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
156         long companyId, boolean showSystem, boolean showPortal)
157         throws com.liferay.portal.kernel.exception.SystemException;
158 
159     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
160     public boolean hasPortlet(long companyId, java.lang.String portletId)
161         throws com.liferay.portal.kernel.exception.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     public com.liferay.portal.model.Portlet newPortlet(long companyId,
173         java.lang.String portletId);
174 
175     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
176         java.lang.String portletId, java.lang.String roles, boolean active)
177         throws com.liferay.portal.kernel.exception.SystemException;
178 }