1   /**
2    * Copyright (c) 2000-2008 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  
26  /**
27   * <a href="PortletLocalService.java.html"><b><i>View Source</i></b></a>
28   *
29   * <p>
30   * ServiceBuilder generated this class. Modifications in this class will be
31   * overwritten the next time is generated.
32   * </p>
33   *
34   * <p>
35   * This interface defines the service. The default implementation is
36   * <code>com.liferay.portal.service.impl.PortletLocalServiceImpl</code>.
37   * Modify methods in that class and rerun ServiceBuilder to populate this class
38   * and all other generated classes.
39   * </p>
40   *
41   * <p>
42   * 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.
43   * </p>
44   *
45   * @author Brian Wing Shun Chan
46   *
47   * @see com.liferay.portal.service.PortletLocalServiceUtil
48   *
49   */
50  public interface PortletLocalService {
51      public com.liferay.portal.model.Portlet addPortlet(
52          com.liferay.portal.model.Portlet portlet)
53          throws com.liferay.portal.SystemException;
54  
55      public void deletePortlet(long id)
56          throws com.liferay.portal.SystemException,
57              com.liferay.portal.PortalException;
58  
59      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
60          throws com.liferay.portal.SystemException;
61  
62      public java.util.List<Object> dynamicQuery(
63          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
64          throws com.liferay.portal.SystemException;
65  
66      public java.util.List<Object> dynamicQuery(
67          com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
68          int end) throws com.liferay.portal.SystemException;
69  
70      public com.liferay.portal.model.Portlet getPortlet(long id)
71          throws com.liferay.portal.SystemException,
72              com.liferay.portal.PortalException;
73  
74      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
75          int start, int end) throws com.liferay.portal.SystemException;
76  
77      public int getPortletsCount() throws com.liferay.portal.SystemException;
78  
79      public com.liferay.portal.model.Portlet updatePortlet(
80          com.liferay.portal.model.Portlet portlet)
81          throws com.liferay.portal.SystemException;
82  
83      public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
84  
85      public com.liferay.portal.model.PortletCategory getEARDisplay(
86          java.lang.String xml) throws com.liferay.portal.SystemException;
87  
88      public com.liferay.portal.model.PortletCategory getWARDisplay(
89          java.lang.String servletContextName, java.lang.String xml)
90          throws com.liferay.portal.SystemException;
91  
92      public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
93  
94      public com.liferay.portal.model.Portlet getPortletById(long companyId,
95          java.lang.String portletId) throws com.liferay.portal.SystemException;
96  
97      public com.liferay.portal.model.Portlet getPortletByStrutsPath(
98          long companyId, java.lang.String strutsPath)
99          throws com.liferay.portal.SystemException;
100 
101     public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
102 
103     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
104         long companyId) throws com.liferay.portal.SystemException;
105 
106     public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
107         long companyId, boolean showSystem, boolean showPortal)
108         throws com.liferay.portal.SystemException;
109 
110     public boolean hasPortlet(long companyId, java.lang.String portletId)
111         throws com.liferay.portal.SystemException;
112 
113     public void initEAR(java.lang.String[] xmls,
114         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
115 
116     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
117         java.lang.String servletContextName, java.lang.String[] xmls,
118         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
119 
120     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
121         java.lang.String portletId, java.lang.String roles, boolean active)
122         throws com.liferay.portal.SystemException;
123 }