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="PortletLocalServiceUtil.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 class provides static methods for the
36   * <code>com.liferay.portal.service.PortletLocalService</code>
37   * bean. The static methods of this class calls the same methods of the bean
38   * instance. It's convenient to be able to just write one line to call a method
39   * on a bean instead of writing a lookup call and a method call.
40   * </p>
41   *
42   * <p>
43   * <code>com.liferay.portal.service.PortletLocalServiceFactory</code>
44   * is responsible for the lookup of the bean.
45   * </p>
46   *
47   * @author Brian Wing Shun Chan
48   *
49   * @see com.liferay.portal.service.PortletLocalService
50   * @see com.liferay.portal.service.PortletLocalServiceFactory
51   *
52   */
53  public class PortletLocalServiceUtil {
54      public static com.liferay.portal.model.Portlet addPortlet(
55          com.liferay.portal.model.Portlet portlet)
56          throws com.liferay.portal.SystemException {
57          PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
58  
59          return portletLocalService.addPortlet(portlet);
60      }
61  
62      public static void deletePortlet(long id)
63          throws com.liferay.portal.PortalException,
64              com.liferay.portal.SystemException {
65          PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
66  
67          portletLocalService.deletePortlet(id);
68      }
69  
70      public static void deletePortlet(com.liferay.portal.model.Portlet portlet)
71          throws com.liferay.portal.PortalException,
72              com.liferay.portal.SystemException {
73          PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
74  
75          portletLocalService.deletePortlet(portlet);
76      }
77  
78      public static java.util.List<com.liferay.portal.model.Portlet> dynamicQuery(
79          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer)
80          throws com.liferay.portal.SystemException {
81          PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
82  
83          return portletLocalService.dynamicQuery(queryInitializer);
84      }
85  
86      public static java.util.List<com.liferay.portal.model.Portlet> dynamicQuery(
87          com.liferay.portal.kernel.dao.DynamicQueryInitializer queryInitializer,
88          int begin, int end) throws com.liferay.portal.SystemException {
89          PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
90  
91          return portletLocalService.dynamicQuery(queryInitializer, begin, end);
92      }
93  
94      public static com.liferay.portal.model.Portlet updatePortlet(
95          com.liferay.portal.model.Portlet portlet)
96          throws com.liferay.portal.SystemException {
97          PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
98  
99          return portletLocalService.updatePortlet(portlet);
100     }
101 
102     public static void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
103         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
104 
105         portletLocalService.destroyPortlet(portlet);
106     }
107 
108     public static com.liferay.portal.model.PortletCategory getEARDisplay(
109         java.lang.String xml) throws com.liferay.portal.SystemException {
110         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
111 
112         return portletLocalService.getEARDisplay(xml);
113     }
114 
115     public static com.liferay.portal.model.PortletCategory getWARDisplay(
116         java.lang.String servletContextName, java.lang.String xml)
117         throws com.liferay.portal.SystemException {
118         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
119 
120         return portletLocalService.getWARDisplay(servletContextName, xml);
121     }
122 
123     public static java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
124         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
125 
126         return portletLocalService.getFriendlyURLMappers();
127     }
128 
129     public static com.liferay.portal.model.Portlet getPortletById(
130         long companyId, java.lang.String portletId)
131         throws com.liferay.portal.SystemException {
132         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
133 
134         return portletLocalService.getPortletById(companyId, portletId);
135     }
136 
137     public static com.liferay.portal.model.Portlet getPortletByStrutsPath(
138         long companyId, java.lang.String strutsPath)
139         throws com.liferay.portal.SystemException {
140         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
141 
142         return portletLocalService.getPortletByStrutsPath(companyId, strutsPath);
143     }
144 
145     public static java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
146         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
147 
148         return portletLocalService.getPortlets();
149     }
150 
151     public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
152         long companyId) throws com.liferay.portal.SystemException {
153         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
154 
155         return portletLocalService.getPortlets(companyId);
156     }
157 
158     public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
159         long companyId, boolean showSystem, boolean showPortal)
160         throws com.liferay.portal.SystemException {
161         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
162 
163         return portletLocalService.getPortlets(companyId, showSystem, showPortal);
164     }
165 
166     public static boolean hasPortlet(long companyId, java.lang.String portletId)
167         throws com.liferay.portal.SystemException {
168         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
169 
170         return portletLocalService.hasPortlet(companyId, portletId);
171     }
172 
173     public static void initEAR(java.lang.String[] xmls,
174         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
175         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
176 
177         portletLocalService.initEAR(xmls, pluginPackage);
178     }
179 
180     public static java.util.List<com.liferay.portal.model.Portlet> initWAR(
181         java.lang.String servletContextName, java.lang.String[] xmls,
182         com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
183         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
184 
185         return portletLocalService.initWAR(servletContextName, xmls,
186             pluginPackage);
187     }
188 
189     public static com.liferay.portal.model.Portlet updatePortlet(
190         long companyId, java.lang.String portletId, java.lang.String roles,
191         boolean active)
192         throws com.liferay.portal.PortalException,
193             com.liferay.portal.SystemException {
194         PortletLocalService portletLocalService = PortletLocalServiceFactory.getService();
195 
196         return portletLocalService.updatePortlet(companyId, portletId, roles,
197             active);
198     }
199 }