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