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