| PortletLocalService.java |
1 /**
2 * Copyright (c) 2000-2007 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 * <a href="PortletLocalService.java.html"><b><i>View Source</i></b></a>
27 *
28 * <p>
29 * ServiceBuilder generated this class. Modifications in this class will be overwritten
30 * the next time is generated.
31 * </p>
32 *
33 * <p>
34 * This interface defines the service. The default implementation is <code>com.liferay.portal.service.impl.PortletLocalServiceImpl</code>.
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
41 * based on the propagated JAAS credentials because this service can only be accessed
42 * from within the same VM.
43 * </p>
44 *
45 * @author Brian Wing Shun Chan
46 *
47 * @see com.liferay.portal.service.PortletServiceFactory
48 * @see com.liferay.portal.service.PortletServiceUtil
49 *
50 */
51 public interface PortletLocalService {
52 public com.liferay.portal.model.Portlet addPortlet(
53 com.liferay.portal.model.Portlet model)
54 throws com.liferay.portal.SystemException;
55
56 public java.util.List dynamicQuery(
57 com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
58 throws com.liferay.portal.SystemException;
59
60 public java.util.List dynamicQuery(
61 com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
62 int begin, int end) throws com.liferay.portal.SystemException;
63
64 public com.liferay.portal.model.Portlet updatePortlet(
65 com.liferay.portal.model.Portlet model)
66 throws com.liferay.portal.SystemException;
67
68 public com.liferay.portal.model.PortletCategory getEARDisplay(
69 java.lang.String xml) throws com.liferay.portal.SystemException;
70
71 public com.liferay.portal.model.PortletCategory getWARDisplay(
72 java.lang.String servletContextName, java.lang.String xml)
73 throws com.liferay.portal.SystemException;
74
75 public java.util.List getFriendlyURLMappers();
76
77 public com.liferay.portal.model.Portlet getPortletById(long companyId,
78 java.lang.String portletId) throws com.liferay.portal.SystemException;
79
80 public com.liferay.portal.model.Portlet getPortletByStrutsPath(
81 long companyId, java.lang.String strutsPath)
82 throws com.liferay.portal.SystemException;
83
84 public java.util.List getPortlets(long companyId)
85 throws com.liferay.portal.SystemException;
86
87 public java.util.List getPortlets(long companyId, boolean showSystem,
88 boolean showPortal) throws com.liferay.portal.SystemException;
89
90 public boolean hasPortlet(long companyId, java.lang.String portletId)
91 throws com.liferay.portal.SystemException;
92
93 public void initEAR(java.lang.String[] xmls,
94 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
95
96 public java.util.List initWAR(java.lang.String servletContextName,
97 java.lang.String[] xmls,
98 com.liferay.portal.kernel.plugin.PluginPackage pluginPackage);
99
100 public com.liferay.portal.model.Portlet updatePortlet(long companyId,
101 java.lang.String portletId, java.lang.String roles, boolean active)
102 throws com.liferay.portal.SystemException,
103 com.liferay.portal.PortalException;
104 }