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.PortletLocalServiceFactory
48   * @see com.liferay.portal.service.PortletLocalServiceUtil
49   *
50   */
51  public interface PortletLocalService {
52      public com.liferay.portal.model.Portlet addPortlet(
53          com.liferay.portal.model.Portlet portlet)
54          throws com.liferay.portal.SystemException;
55  
56      public void deletePortlet(long id)
57          throws com.liferay.portal.SystemException,
58              com.liferay.portal.PortalException;
59  
60      public void deletePortlet(com.liferay.portal.model.Portlet portlet)
61          throws com.liferay.portal.SystemException,
62              com.liferay.portal.PortalException;
63  
64      public java.util.List<com.liferay.portal.model.Portlet> dynamicQuery(
65          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
66          throws com.liferay.portal.SystemException;
67  
68      public java.util.List<com.liferay.portal.model.Portlet> dynamicQuery(
69          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
70          int begin, int end) throws com.liferay.portal.SystemException;
71  
72      public com.liferay.portal.model.Portlet updatePortlet(
73          com.liferay.portal.model.Portlet portlet)
74          throws com.liferay.portal.SystemException;
75  
76      public void destroyPortlet(com.liferay.portal.model.Portlet portlet);
77  
78      public com.liferay.portal.model.PortletCategory getEARDisplay(
79          java.lang.String xml) throws com.liferay.portal.SystemException;
80  
81      public com.liferay.portal.model.PortletCategory getWARDisplay(
82          java.lang.String servletContextName, java.lang.String xml)
83          throws com.liferay.portal.SystemException;
84  
85      public java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers();
86  
87      public com.liferay.portal.model.Portlet getPortletById(long companyId,
88          java.lang.String portletId) throws com.liferay.portal.SystemException;
89  
90      public com.liferay.portal.model.Portlet getPortletByStrutsPath(
91          long companyId, java.lang.String strutsPath)
92          throws com.liferay.portal.SystemException;
93  
94      public java.util.List<com.liferay.portal.model.Portlet> getPortlets();
95  
96      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
97          long companyId) throws com.liferay.portal.SystemException;
98  
99      public java.util.List<com.liferay.portal.model.Portlet> getPortlets(
100         long companyId, boolean showSystem, boolean showPortal)
101         throws com.liferay.portal.SystemException;
102 
103     public boolean hasPortlet(long companyId, java.lang.String portletId)
104         throws com.liferay.portal.SystemException;
105 
106     public void initEAR(java.lang.String[] xmls,
107         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
108 
109     public java.util.List<com.liferay.portal.model.Portlet> initWAR(
110         java.lang.String servletContextName, java.lang.String[] xmls,
111         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
112 
113     public com.liferay.portal.model.Portlet updatePortlet(long companyId,
114         java.lang.String portletId, java.lang.String roles, boolean active)
115         throws com.liferay.portal.SystemException,
116             com.liferay.portal.PortalException;
117 }