001    /**
002     * Copyright (c) 2000-2012 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    import com.liferay.portal.kernel.util.ReferenceRegistry;
019    
020    /**
021     * 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.
022     *
023     * <p>
024     * 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.
025     * </p>
026     *
027     * @author Brian Wing Shun Chan
028     * @see PortletLocalService
029     * @see com.liferay.portal.service.base.PortletLocalServiceBaseImpl
030     * @see com.liferay.portal.service.impl.PortletLocalServiceImpl
031     * @generated
032     */
033    public class PortletLocalServiceUtil {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PortletLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
038             */
039    
040            /**
041            * Adds the portlet to the database. Also notifies the appropriate model listeners.
042            *
043            * @param portlet the portlet
044            * @return the portlet that was added
045            * @throws SystemException if a system exception occurred
046            */
047            public static com.liferay.portal.model.Portlet addPortlet(
048                    com.liferay.portal.model.Portlet portlet)
049                    throws com.liferay.portal.kernel.exception.SystemException {
050                    return getService().addPortlet(portlet);
051            }
052    
053            /**
054            * Creates a new portlet with the primary key. Does not add the portlet to the database.
055            *
056            * @param id the primary key for the new portlet
057            * @return the new portlet
058            */
059            public static com.liferay.portal.model.Portlet createPortlet(long id) {
060                    return getService().createPortlet(id);
061            }
062    
063            /**
064            * Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.
065            *
066            * @param id the primary key of the portlet
067            * @return the portlet that was removed
068            * @throws PortalException if a portlet with the primary key could not be found
069            * @throws SystemException if a system exception occurred
070            */
071            public static com.liferay.portal.model.Portlet deletePortlet(long id)
072                    throws com.liferay.portal.kernel.exception.PortalException,
073                            com.liferay.portal.kernel.exception.SystemException {
074                    return getService().deletePortlet(id);
075            }
076    
077            /**
078            * Deletes the portlet from the database. Also notifies the appropriate model listeners.
079            *
080            * @param portlet the portlet
081            * @return the portlet that was removed
082            * @throws SystemException if a system exception occurred
083            */
084            public static com.liferay.portal.model.Portlet deletePortlet(
085                    com.liferay.portal.model.Portlet portlet)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    return getService().deletePortlet(portlet);
088            }
089    
090            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
091                    return getService().dynamicQuery();
092            }
093    
094            /**
095            * Performs a dynamic query on the database and returns the matching rows.
096            *
097            * @param dynamicQuery the dynamic query
098            * @return the matching rows
099            * @throws SystemException if a system exception occurred
100            */
101            @SuppressWarnings("rawtypes")
102            public static java.util.List dynamicQuery(
103                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
104                    throws com.liferay.portal.kernel.exception.SystemException {
105                    return getService().dynamicQuery(dynamicQuery);
106            }
107    
108            /**
109            * Performs a dynamic query on the database and returns a range of the matching rows.
110            *
111            * <p>
112            * 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.
113            * </p>
114            *
115            * @param dynamicQuery the dynamic query
116            * @param start the lower bound of the range of model instances
117            * @param end the upper bound of the range of model instances (not inclusive)
118            * @return the range of matching rows
119            * @throws SystemException if a system exception occurred
120            */
121            @SuppressWarnings("rawtypes")
122            public static java.util.List dynamicQuery(
123                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
124                    int end) throws com.liferay.portal.kernel.exception.SystemException {
125                    return getService().dynamicQuery(dynamicQuery, start, end);
126            }
127    
128            /**
129            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
130            *
131            * <p>
132            * 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.
133            * </p>
134            *
135            * @param dynamicQuery the dynamic query
136            * @param start the lower bound of the range of model instances
137            * @param end the upper bound of the range of model instances (not inclusive)
138            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
139            * @return the ordered range of matching rows
140            * @throws SystemException if a system exception occurred
141            */
142            @SuppressWarnings("rawtypes")
143            public static java.util.List dynamicQuery(
144                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
145                    int end,
146                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
147                    throws com.liferay.portal.kernel.exception.SystemException {
148                    return getService()
149                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
150            }
151    
152            /**
153            * Returns the number of rows that match the dynamic query.
154            *
155            * @param dynamicQuery the dynamic query
156            * @return the number of rows that match the dynamic query
157            * @throws SystemException if a system exception occurred
158            */
159            public static long dynamicQueryCount(
160                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
161                    throws com.liferay.portal.kernel.exception.SystemException {
162                    return getService().dynamicQueryCount(dynamicQuery);
163            }
164    
165            public static com.liferay.portal.model.Portlet fetchPortlet(long id)
166                    throws com.liferay.portal.kernel.exception.SystemException {
167                    return getService().fetchPortlet(id);
168            }
169    
170            /**
171            * Returns the portlet with the primary key.
172            *
173            * @param id the primary key of the portlet
174            * @return the portlet
175            * @throws PortalException if a portlet with the primary key could not be found
176            * @throws SystemException if a system exception occurred
177            */
178            public static com.liferay.portal.model.Portlet getPortlet(long id)
179                    throws com.liferay.portal.kernel.exception.PortalException,
180                            com.liferay.portal.kernel.exception.SystemException {
181                    return getService().getPortlet(id);
182            }
183    
184            public static com.liferay.portal.model.PersistedModel getPersistedModel(
185                    java.io.Serializable primaryKeyObj)
186                    throws com.liferay.portal.kernel.exception.PortalException,
187                            com.liferay.portal.kernel.exception.SystemException {
188                    return getService().getPersistedModel(primaryKeyObj);
189            }
190    
191            /**
192            * Returns a range of all the portlets.
193            *
194            * <p>
195            * 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.
196            * </p>
197            *
198            * @param start the lower bound of the range of portlets
199            * @param end the upper bound of the range of portlets (not inclusive)
200            * @return the range of portlets
201            * @throws SystemException if a system exception occurred
202            */
203            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
204                    int start, int end)
205                    throws com.liferay.portal.kernel.exception.SystemException {
206                    return getService().getPortlets(start, end);
207            }
208    
209            /**
210            * Returns the number of portlets.
211            *
212            * @return the number of portlets
213            * @throws SystemException if a system exception occurred
214            */
215            public static int getPortletsCount()
216                    throws com.liferay.portal.kernel.exception.SystemException {
217                    return getService().getPortletsCount();
218            }
219    
220            /**
221            * Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
222            *
223            * @param portlet the portlet
224            * @return the portlet that was updated
225            * @throws SystemException if a system exception occurred
226            */
227            public static com.liferay.portal.model.Portlet updatePortlet(
228                    com.liferay.portal.model.Portlet portlet)
229                    throws com.liferay.portal.kernel.exception.SystemException {
230                    return getService().updatePortlet(portlet);
231            }
232    
233            /**
234            * Returns the Spring bean ID for this bean.
235            *
236            * @return the Spring bean ID for this bean
237            */
238            public static java.lang.String getBeanIdentifier() {
239                    return getService().getBeanIdentifier();
240            }
241    
242            /**
243            * Sets the Spring bean ID for this bean.
244            *
245            * @param beanIdentifier the Spring bean ID for this bean
246            */
247            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
248                    getService().setBeanIdentifier(beanIdentifier);
249            }
250    
251            public static void addPortletCategory(long companyId,
252                    java.lang.String categoryName) {
253                    getService().addPortletCategory(companyId, categoryName);
254            }
255    
256            public static void checkPortlet(com.liferay.portal.model.Portlet portlet)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException {
259                    getService().checkPortlet(portlet);
260            }
261    
262            public static void checkPortlets(long companyId)
263                    throws com.liferay.portal.kernel.exception.PortalException,
264                            com.liferay.portal.kernel.exception.SystemException {
265                    getService().checkPortlets(companyId);
266            }
267    
268            public static void clearCache() {
269                    getService().clearCache();
270            }
271    
272            public static void clearCompanyPortletsPool() {
273                    getService().clearCompanyPortletsPool();
274            }
275    
276            /**
277            * @deprecated {@link #clonePortlet(String)}
278            */
279            public static com.liferay.portal.model.Portlet clonePortlet(
280                    long companyId, java.lang.String portletId) {
281                    return getService().clonePortlet(companyId, portletId);
282            }
283    
284            public static com.liferay.portal.model.Portlet clonePortlet(
285                    java.lang.String portletId) {
286                    return getService().clonePortlet(portletId);
287            }
288    
289            public static void deletePortlet(long companyId,
290                    java.lang.String portletId, long plid)
291                    throws com.liferay.portal.kernel.exception.PortalException,
292                            com.liferay.portal.kernel.exception.SystemException {
293                    getService().deletePortlet(companyId, portletId, plid);
294            }
295    
296            public static void deletePortlets(long companyId,
297                    java.lang.String[] portletIds, long plid)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    getService().deletePortlets(companyId, portletIds, plid);
301            }
302    
303            public static com.liferay.portal.model.Portlet deployRemotePortlet(
304                    com.liferay.portal.model.Portlet portlet, java.lang.String categoryName)
305                    throws com.liferay.portal.kernel.exception.PortalException,
306                            com.liferay.portal.kernel.exception.SystemException {
307                    return getService().deployRemotePortlet(portlet, categoryName);
308            }
309    
310            public static com.liferay.portal.model.Portlet deployRemotePortlet(
311                    com.liferay.portal.model.Portlet portlet,
312                    java.lang.String[] categoryNames)
313                    throws com.liferay.portal.kernel.exception.PortalException,
314                            com.liferay.portal.kernel.exception.SystemException {
315                    return getService().deployRemotePortlet(portlet, categoryNames);
316            }
317    
318            public static void destroyPortlet(com.liferay.portal.model.Portlet portlet) {
319                    getService().destroyPortlet(portlet);
320            }
321    
322            public static void destroyRemotePortlet(
323                    com.liferay.portal.model.Portlet portlet) {
324                    getService().destroyRemotePortlet(portlet);
325            }
326    
327            public static java.util.List<com.liferay.portlet.expando.model.CustomAttributesDisplay> getCustomAttributesDisplays() {
328                    return getService().getCustomAttributesDisplays();
329            }
330    
331            public static com.liferay.portal.model.PortletCategory getEARDisplay(
332                    java.lang.String xml)
333                    throws com.liferay.portal.kernel.exception.SystemException {
334                    return getService().getEARDisplay(xml);
335            }
336    
337            public static java.util.List<com.liferay.portal.model.Portlet> getFriendlyURLMapperPortlets() {
338                    return getService().getFriendlyURLMapperPortlets();
339            }
340    
341            public static java.util.List<com.liferay.portal.kernel.portlet.FriendlyURLMapper> getFriendlyURLMappers() {
342                    return getService().getFriendlyURLMappers();
343            }
344    
345            public static com.liferay.portal.model.PortletApp getPortletApp(
346                    java.lang.String servletContextName) {
347                    return getService().getPortletApp(servletContextName);
348            }
349    
350            public static com.liferay.portal.model.Portlet getPortletById(
351                    long companyId, java.lang.String portletId)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getPortletById(companyId, portletId);
354            }
355    
356            public static com.liferay.portal.model.Portlet getPortletById(
357                    java.lang.String portletId) {
358                    return getService().getPortletById(portletId);
359            }
360    
361            public static com.liferay.portal.model.Portlet getPortletByStrutsPath(
362                    long companyId, java.lang.String strutsPath)
363                    throws com.liferay.portal.kernel.exception.SystemException {
364                    return getService().getPortletByStrutsPath(companyId, strutsPath);
365            }
366    
367            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets() {
368                    return getService().getPortlets();
369            }
370    
371            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
372                    long companyId)
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getPortlets(companyId);
375            }
376    
377            public static java.util.List<com.liferay.portal.model.Portlet> getPortlets(
378                    long companyId, boolean showSystem, boolean showPortal)
379                    throws com.liferay.portal.kernel.exception.SystemException {
380                    return getService().getPortlets(companyId, showSystem, showPortal);
381            }
382    
383            public static java.util.List<com.liferay.portal.model.Portlet> getScopablePortlets() {
384                    return getService().getScopablePortlets();
385            }
386    
387            public static com.liferay.portal.model.PortletCategory getWARDisplay(
388                    java.lang.String servletContextName, java.lang.String xml)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService().getWARDisplay(servletContextName, xml);
391            }
392    
393            public static boolean hasPortlet(long companyId, java.lang.String portletId)
394                    throws com.liferay.portal.kernel.exception.SystemException {
395                    return getService().hasPortlet(companyId, portletId);
396            }
397    
398            public static void initEAR(javax.servlet.ServletContext servletContext,
399                    java.lang.String[] xmls,
400                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
401                    getService().initEAR(servletContext, xmls, pluginPackage);
402            }
403    
404            public static java.util.List<com.liferay.portal.model.Portlet> initWAR(
405                    java.lang.String servletContextName,
406                    javax.servlet.ServletContext servletContext, java.lang.String[] xmls,
407                    com.liferay.portal.kernel.plugin.PluginPackage pluginPackage) {
408                    return getService()
409                                       .initWAR(servletContextName, servletContext, xmls,
410                            pluginPackage);
411            }
412    
413            public static java.util.Map<java.lang.String, com.liferay.portal.model.Portlet> loadGetPortletsPool(
414                    long companyId)
415                    throws com.liferay.portal.kernel.exception.SystemException {
416                    return getService().loadGetPortletsPool(companyId);
417            }
418    
419            public static void removeCompanyPortletsPool(long companyId) {
420                    getService().removeCompanyPortletsPool(companyId);
421            }
422    
423            public static com.liferay.portal.model.Portlet updatePortlet(
424                    long companyId, java.lang.String portletId, java.lang.String roles,
425                    boolean active)
426                    throws com.liferay.portal.kernel.exception.SystemException {
427                    return getService().updatePortlet(companyId, portletId, roles, active);
428            }
429    
430            public static PortletLocalService getService() {
431                    if (_service == null) {
432                            _service = (PortletLocalService)PortalBeanLocatorUtil.locate(PortletLocalService.class.getName());
433    
434                            ReferenceRegistry.registerReference(PortletLocalServiceUtil.class,
435                                    "_service");
436                    }
437    
438                    return _service;
439            }
440    
441            /**
442             * @deprecated
443             */
444            public void setService(PortletLocalService service) {
445            }
446    
447            private static PortletLocalService _service;
448    }