001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * The utility for the portlet local service. This utility wraps {@link com.liferay.portal.service.impl.PortletLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PortletLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see PortletLocalService
032     * @see com.liferay.portal.service.base.PortletLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.PortletLocalServiceImpl
034     * @generated
035     */
036    public class PortletLocalServiceUtil {
037            /**
038            * Adds the portlet to the database. Also notifies the appropriate model listeners.
039            *
040            * @param portlet the portlet to add
041            * @return the portlet that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.Portlet addPortlet(
045                    com.liferay.portal.model.Portlet portlet)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addPortlet(portlet);
048            }
049    
050            /**
051            * Creates a new portlet with the primary key. Does not add the portlet to the database.
052            *
053            * @param id the primary key for the new portlet
054            * @return the new portlet
055            */
056            public static com.liferay.portal.model.Portlet createPortlet(long id) {
057                    return getService().createPortlet(id);
058            }
059    
060            /**
061            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
062            *
063            * @param id the primary key of the portlet to delete
064            * @throws PortalException if a portlet with the primary key could not be found
065            * @throws SystemException if a system exception occurred
066            */
067            public static void deletePortlet(long id)
068                    throws com.liferay.portal.kernel.exception.PortalException,
069                            com.liferay.portal.kernel.exception.SystemException {
070                    getService().deletePortlet(id);
071            }
072    
073            /**
074            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
075            *
076            * @param portlet the portlet to delete
077            * @throws SystemException if a system exception occurred
078            */
079            public static void deletePortlet(com.liferay.portal.model.Portlet portlet)
080                    throws com.liferay.portal.kernel.exception.SystemException {
081                    getService().deletePortlet(portlet);
082            }
083    
084            /**
085            * Performs a dynamic query on the database and returns the matching rows.
086            *
087            * @param dynamicQuery the dynamic query to search with
088            * @return the matching rows
089            * @throws SystemException if a system exception occurred
090            */
091            @SuppressWarnings("rawtypes")
092            public static java.util.List dynamicQuery(
093                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
094                    throws com.liferay.portal.kernel.exception.SystemException {
095                    return getService().dynamicQuery(dynamicQuery);
096            }
097    
098            /**
099            * Performs a dynamic query on the database and returns a range of the matching rows.
100            *
101            * <p>
102            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
103            * </p>
104            *
105            * @param dynamicQuery the dynamic query to search with
106            * @param start the lower bound of the range of model instances to return
107            * @param end the upper bound of the range of model instances to return (not inclusive)
108            * @return the range of matching rows
109            * @throws SystemException if a system exception occurred
110            */
111            @SuppressWarnings("rawtypes")
112            public static java.util.List dynamicQuery(
113                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
114                    int end) throws com.liferay.portal.kernel.exception.SystemException {
115                    return getService().dynamicQuery(dynamicQuery, start, end);
116            }
117    
118            /**
119            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
120            *
121            * <p>
122            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query to search with
126            * @param start the lower bound of the range of model instances to return
127            * @param end the upper bound of the range of model instances to return (not inclusive)
128            * @param orderByComparator the comparator to order the results by
129            * @return the ordered range of matching rows
130            * @throws SystemException if a system exception occurred
131            */
132            @SuppressWarnings("rawtypes")
133            public static java.util.List dynamicQuery(
134                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
135                    int end,
136                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
137                    throws com.liferay.portal.kernel.exception.SystemException {
138                    return getService()
139                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
140            }
141    
142            /**
143            * Counts the number of rows that match the dynamic query.
144            *
145            * @param dynamicQuery the dynamic query to search with
146            * @return the number of rows that match the dynamic query
147            * @throws SystemException if a system exception occurred
148            */
149            public static long dynamicQueryCount(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
151                    throws com.liferay.portal.kernel.exception.SystemException {
152                    return getService().dynamicQueryCount(dynamicQuery);
153            }
154    
155            /**
156            * Gets the portlet with the primary key.
157            *
158            * @param id the primary key of the portlet to get
159            * @return the portlet
160            * @throws PortalException if a portlet with the primary key could not be found
161            * @throws SystemException if a system exception occurred
162            */
163            public static com.liferay.portal.model.Portlet getPortlet(long id)
164                    throws com.liferay.portal.kernel.exception.PortalException,
165                            com.liferay.portal.kernel.exception.SystemException {
166                    return getService().getPortlet(id);
167            }
168    
169            /**
170            * Gets a range of all the portlets.
171            *
172            * <p>
173            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
174            * </p>
175            *
176            * @param start the lower bound of the range of portlets to return
177            * @param end the upper bound of the range of portlets to return (not inclusive)
178            * @return the range of portlets
179            * @throws SystemException if a system exception occurred
180            */
181            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
182                    int start, int end)
183                    throws com.liferay.portal.kernel.exception.SystemException {
184                    return getService().getPortlets(start, end);
185            }
186    
187            /**
188            * Gets the number of portlets.
189            *
190            * @return the number of portlets
191            * @throws SystemException if a system exception occurred
192            */
193            public static int getPortletsCount()
194                    throws com.liferay.portal.kernel.exception.SystemException {
195                    return getService().getPortletsCount();
196            }
197    
198            /**
199            * Updates the portlet in the database. Also notifies the appropriate model listeners.
200            *
201            * @param portlet the portlet to update
202            * @return the portlet that was updated
203            * @throws SystemException if a system exception occurred
204            */
205            public static com.liferay.portal.model.Portlet updatePortlet(
206                    com.liferay.portal.model.Portlet portlet)
207                    throws com.liferay.portal.kernel.exception.SystemException {
208                    return getService().updatePortlet(portlet);
209            }
210    
211            /**
212            * Updates the portlet in the database. Also notifies the appropriate model listeners.
213            *
214            * @param portlet the portlet to update
215            * @param merge whether to merge the portlet with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
216            * @return the portlet that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portal.model.Portlet updatePortlet(
220                    com.liferay.portal.model.Portlet portlet, boolean merge)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updatePortlet(portlet, merge);
223            }
224    
225            public static void checkPortlet(com.liferay.portal.model.Portlet portlet)
226                    throws com.liferay.portal.kernel.exception.PortalException,
227                            com.liferay.portal.kernel.exception.SystemException {
228                    getService().checkPortlet(portlet);
229            }
230    
231            public static void checkPortlets(long companyId)
232                    throws com.liferay.portal.kernel.exception.PortalException,
233                            com.liferay.portal.kernel.exception.SystemException {
234                    getService().checkPortlets(companyId);
235            }
236    
237            public static void clearCache() {
238                    getService().clearCache();
239            }
240    
241            public static com.liferay.portal.model.Portlet clonePortlet(
242                    long companyId, java.lang.String portletId)
243                    throws com.liferay.portal.kernel.exception.SystemException {
244                    return getService().clonePortlet(companyId, portletId);
245            }
246    
247            public static com.liferay.portal.model.Portlet deployRemotePortlet(
248                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
249                    throws com.liferay.portal.kernel.exception.SystemException {
250                    return getService().deployRemotePortlet(portlet, categoryName);
251            }
252    
253            public static void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
254                    getService().destroyPortlet(portlet);
255            }
256    
257            public static void destroyRemotePortlet(
258                    com.liferay.portal.model.Portlet portlet) {
259                    getService().destroyRemotePortlet(portlet);
260            }
261    
262            public static java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays() {
263                    return getService().getCustomAttributesDisplays();
264            }
265    
266            public static com.liferay.portal.model.PortletCategory getEARDisplay(
267                    java.lang.String xml)
268                    throws com.liferay.portal.kernel.exception.SystemException {
269                    return getService().getEARDisplay(xml);
270            }
271    
272            public static java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets() {
273                    return getService().getFriendlyURLMapperPortlets();
274            }
275    
276            public static java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
277                    return getService().getFriendlyURLMappers();
278            }
279    
280            public static com.liferay.portal.model.PortletApp getPortletApp(
281                    java.lang.String servletContextName) {
282                    return getService().getPortletApp(servletContextName);
283            }
284    
285            public static com.liferay.portal.model.Portlet getPortletById(
286                    long companyId, java.lang.String portletId)
287                    throws com.liferay.portal.kernel.exception.SystemException {
288                    return getService().getPortletById(companyId, portletId);
289            }
290    
291            public static com.liferay.portal.model.Portlet getPortletById(
292                    java.lang.String portletId) {
293                    return getService().getPortletById(portletId);
294            }
295    
296            public static com.liferay.portal.model.Portlet getPortletByStrutsPath(
297                    long companyId, java.lang.String strutsPath)
298                    throws com.liferay.portal.kernel.exception.SystemException {
299                    return getService().getPortletByStrutsPath(companyId, strutsPath);
300            }
301    
302            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
303                    return getService().getPortlets();
304            }
305    
306            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
307                    long companyId)
308                    throws com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getPortlets(companyId);
310            }
311    
312            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
313                    long companyId, boolean showSystem, boolean showPortal)
314                    throws com.liferay.portal.kernel.exception.SystemException {
315                    return getService().getPortlets(companyId, showSystem, showPortal);
316            }
317    
318            public static com.liferay.portal.model.PortletCategory getWARDisplay(
319                    java.lang.String servletContextName, java.lang.String xml)
320                    throws com.liferay.portal.kernel.exception.SystemException {
321                    return getService().getWARDisplay(servletContextName, xml);
322            }
323    
324            public static boolean hasPortlet(long companyId, java.lang.String portletId)
325                    throws com.liferay.portal.kernel.exception.SystemException {
326                    return getService().hasPortlet(companyId, portletId);
327            }
328    
329            public static void initEAR(javax.servlet.ServletContext servletContext,
330                    java.lang.String[] xmls,
331                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
332                    getService().initEAR(servletContext, xmls, pluginPackage);
333            }
334    
335            public static java.util.List<com.liferay.portal.model.Portlet> initWAR(
336                    java.lang.String servletContextName,
337                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
338                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
339                    return getService()
340                                       .initWAR(servletContextName, servletContext, xmls,
341                            pluginPackage);
342            }
343    
344            public static com.liferay.portal.model.Portlet updatePortlet(
345                    long companyId, java.lang.String portletId, java.lang.String roles,
346                    boolean active)
347                    throws com.liferay.portal.kernel.exception.SystemException {
348                    return getService().updatePortlet(companyId, portletId, roles, active);
349            }
350    
351            public static PortletLocalService getService() {
352                    if (_service == null) {
353                            _service = (PortletLocalService)PortalBeanLocatorUtil.locate(PortletLocalService.class.getName());
354                    }
355    
356                    return _service;
357            }
358    
359            public void setService(PortletLocalService service) {
360                    _service = service;
361            }
362    
363            private static PortletLocalService _service;
364    }