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