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