1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.service;
24  
25  import com.liferay.portal.PortalException;
26  import com.liferay.portal.SystemException;
27  import com.liferay.portal.kernel.annotation.Propagation;
28  import com.liferay.portal.kernel.annotation.Transactional;
29  
30  /**
31   * <a href="PortletLocalService.java.html"><b><i>View Source</i></b></a>
32   *
33   * <p>
34   * ServiceBuilder generated this class. Modifications in this class will be
35   * overwritten the next time is generated.
36   * </p>
37   *
38   * <p>
39   * This interface defines the service. The default implementation is
40   * <code>com.liferay.portal.service.impl.PortletLocalServiceImpl</code>.
41   * Modify methods in that class and rerun ServiceBuilder to populate this class
42   * and all other generated classes.
43   * </p>
44   *
45   * <p>
46   * 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.
47   * </p>
48   *
49   * @author Brian Wing Shun Chan
50   *
51   * @see com.liferay.portal.service.PortletLocalServiceUtil
52   *
53   */
54  @Transactional(rollbackFor =  {
55      PortalException.class, SystemException.class})
56  public interface PortletLocalService {
57      public com.liferay.portal.model.Portlet addPortlet(
58          com.liferay.portal.model.Portlet portlet)
59          throws com.liferay.portal.SystemException;
60  
61      public com.liferay.portal.model.Portlet createPortlet(long id);
62  
63      public void deletePortlet(long id)
64          throws com.liferay.portal.SystemException,
65              com.liferay.portal.PortalException;
66  
67      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
68          throws com.liferay.portal.SystemException;
69  
70      public java.util.List<Object> dynamicQuery(
71          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
72          throws com.liferay.portal.SystemException;
73  
74      public java.util.List<Object> dynamicQuery(
75          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
76          int end) throws com.liferay.portal.SystemException;
77  
78      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
79      public com.liferay.portal.model.Portlet getPortlet(long id)
80          throws com.liferay.portal.SystemException,
81              com.liferay.portal.PortalException;
82  
83      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
84      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
85          int start, int end) throws com.liferay.portal.SystemException;
86  
87      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
88      public int getPortletsCount() throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Portlet updatePortlet(
91          com.liferay.portal.model.Portlet portlet)
92          throws com.liferay.portal.SystemException;
93  
94      public com.liferay.portal.model.Portlet deployRemotePortlet(
95          com.liferay.portal.model.Portlet portlet);
96  
97      public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
98  
99      @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
100     public com.liferay.portal.model.PortletCategory getEARDisplay(
101         java.lang.String xml) throws com.liferay.portal.SystemException;
102 
103     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
104     public com.liferay.portal.model.PortletCategory getWARDisplay(
105         java.lang.String servletContextName, java.lang.String xml)
106         throws com.liferay.portal.SystemException;
107 
108     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
109     public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
110 
111     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
112     public com.liferay.portal.model.Portlet getPortletById(long companyId,
113         java.lang.String portletId) throws com.liferay.portal.SystemException;
114 
115     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
116     public com.liferay.portal.model.Portlet getPortletByStrutsPath(
117         long companyId, java.lang.String strutsPath)
118         throws com.liferay.portal.SystemException;
119 
120     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
121     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
122 
123     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
124     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
125         long companyId) throws com.liferay.portal.SystemException;
126 
127     @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
128     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
129         long companyId, boolean showSystem, boolean showPortal)
130         throws com.liferay.portal.SystemException;
131 
132     public boolean hasPortlet(long companyId, java.lang.String portletId)
133         throws com.liferay.portal.SystemException;
134 
135     public void initEAR(javax.servlet.ServletContext servletContext,
136         java.lang.String[] xmls,
137         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
138 
139     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
140         java.lang.String servletContextName,
141         javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
142         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
143 
144     public com.liferay.portal.model.Portlet newPortlet(long companyId,
145         java.lang.String portletId);
146 
147     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
148         java.lang.String portletId, java.lang.String roles, boolean active)
149         throws com.liferay.portal.SystemException;
150 }