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