001    /**
002     * Copyright (c) 2000-2011 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.MethodCache;
019    import com.liferay.portal.kernel.util.ReferenceRegistry;
020    
021    /**
022     * The utility for the portlet preferences local service. This utility wraps {@link com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server.
023     *
024     * <p>
025     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
026     * </p>
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            * @throws PortalException if a portlet preferences with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deletePortletPreferences(long portletPreferencesId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deletePortletPreferences(portletPreferencesId);
076            }
077    
078            /**
079            * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
080            *
081            * @param portletPreferences the portlet preferences
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deletePortletPreferences(
085                    com.liferay.portal.model.PortletPreferences portletPreferences)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deletePortletPreferences(portletPreferences);
088            }
089    
090            /**
091            * Performs a dynamic query on the database and returns the matching rows.
092            *
093            * @param dynamicQuery the dynamic query
094            * @return the matching rows
095            * @throws SystemException if a system exception occurred
096            */
097            @SuppressWarnings("rawtypes")
098            public static java.util.List dynamicQuery(
099                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
100                    throws com.liferay.portal.kernel.exception.SystemException {
101                    return getService().dynamicQuery(dynamicQuery);
102            }
103    
104            /**
105            * Performs a dynamic query on the database and returns a range of the matching rows.
106            *
107            * <p>
108            * 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.
109            * </p>
110            *
111            * @param dynamicQuery the dynamic query
112            * @param start the lower bound of the range of model instances
113            * @param end the upper bound of the range of model instances (not inclusive)
114            * @return the range of matching rows
115            * @throws SystemException if a system exception occurred
116            */
117            @SuppressWarnings("rawtypes")
118            public static java.util.List dynamicQuery(
119                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
120                    int end) throws com.liferay.portal.kernel.exception.SystemException {
121                    return getService().dynamicQuery(dynamicQuery, start, end);
122            }
123    
124            /**
125            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
126            *
127            * <p>
128            * 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.
129            * </p>
130            *
131            * @param dynamicQuery the dynamic query
132            * @param start the lower bound of the range of model instances
133            * @param end the upper bound of the range of model instances (not inclusive)
134            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
135            * @return the ordered range of matching rows
136            * @throws SystemException if a system exception occurred
137            */
138            @SuppressWarnings("rawtypes")
139            public static java.util.List dynamicQuery(
140                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
141                    int end,
142                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
143                    throws com.liferay.portal.kernel.exception.SystemException {
144                    return getService()
145                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
146            }
147    
148            /**
149            * Returns the number of rows that match the dynamic query.
150            *
151            * @param dynamicQuery the dynamic query
152            * @return the number of rows that match the dynamic query
153            * @throws SystemException if a system exception occurred
154            */
155            public static long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
157                    throws com.liferay.portal.kernel.exception.SystemException {
158                    return getService().dynamicQueryCount(dynamicQuery);
159            }
160    
161            /**
162            * Returns the portlet preferences with the primary key.
163            *
164            * @param portletPreferencesId the primary key of the portlet preferences
165            * @return the portlet preferences
166            * @throws PortalException if a portlet preferences with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portal.model.PortletPreferences getPortletPreferences(
170                    long portletPreferencesId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getPortletPreferences(portletPreferencesId);
174            }
175    
176            public static com.liferay.portal.model.PersistedModel getPersistedModel(
177                    java.io.Serializable primaryKeyObj)
178                    throws com.liferay.portal.kernel.exception.PortalException,
179                            com.liferay.portal.kernel.exception.SystemException {
180                    return getService().getPersistedModel(primaryKeyObj);
181            }
182    
183            /**
184            * Returns a range of all the portlet preferenceses.
185            *
186            * <p>
187            * 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.
188            * </p>
189            *
190            * @param start the lower bound of the range of portlet preferenceses
191            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
192            * @return the range of portlet preferenceses
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getPortletPreferenceses(start, end);
199            }
200    
201            /**
202            * Returns the number of portlet preferenceses.
203            *
204            * @return the number of portlet preferenceses
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getPortletPreferencesesCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getPortletPreferencesesCount();
210            }
211    
212            /**
213            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param portletPreferences the portlet preferences
216            * @return the portlet preferences that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portal.model.PortletPreferences updatePortletPreferences(
220                    com.liferay.portal.model.PortletPreferences portletPreferences)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updatePortletPreferences(portletPreferences);
223            }
224    
225            /**
226            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param portletPreferences the portlet preferences
229            * @param merge whether to merge the portlet preferences with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
230            * @return the portlet preferences that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portal.model.PortletPreferences updatePortletPreferences(
234                    com.liferay.portal.model.PortletPreferences portletPreferences,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updatePortletPreferences(portletPreferences, merge);
238            }
239    
240            /**
241            * Returns the Spring bean ID for this bean.
242            *
243            * @return the Spring bean ID for this bean
244            */
245            public static java.lang.String getBeanIdentifier() {
246                    return getService().getBeanIdentifier();
247            }
248    
249            /**
250            * Sets the Spring bean ID for this bean.
251            *
252            * @param beanIdentifier the Spring bean ID for this bean
253            */
254            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
255                    getService().setBeanIdentifier(beanIdentifier);
256            }
257    
258            public static com.liferay.portal.model.PortletPreferences addPortletPreferences(
259                    long companyId, long ownerId, int ownerType, long plid,
260                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
261                    java.lang.String defaultPreferences)
262                    throws com.liferay.portal.kernel.exception.SystemException {
263                    return getService()
264                                       .addPortletPreferences(companyId, ownerId, ownerType, plid,
265                            portletId, portlet, defaultPreferences);
266            }
267    
268            public static void deletePortletPreferences(long ownerId, int ownerType,
269                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
270                    getService().deletePortletPreferences(ownerId, ownerType, plid);
271            }
272    
273            public static void deletePortletPreferences(long ownerId, int ownerType,
274                    long plid, java.lang.String portletId)
275                    throws com.liferay.portal.kernel.exception.PortalException,
276                            com.liferay.portal.kernel.exception.SystemException {
277                    getService()
278                            .deletePortletPreferences(ownerId, ownerType, plid, portletId);
279            }
280    
281            public static javax.portlet.PortletPreferences getDefaultPreferences(
282                    long companyId, java.lang.String portletId)
283                    throws com.liferay.portal.kernel.exception.SystemException {
284                    return getService().getDefaultPreferences(companyId, portletId);
285            }
286    
287            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences()
288                    throws com.liferay.portal.kernel.exception.SystemException {
289                    return getService().getPortletPreferences();
290            }
291    
292            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
293                    long ownerId, int ownerType, long plid)
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService().getPortletPreferences(ownerId, ownerType, plid);
296            }
297    
298            public static com.liferay.portal.model.PortletPreferences getPortletPreferences(
299                    long ownerId, int ownerType, long plid, java.lang.String portletId)
300                    throws com.liferay.portal.kernel.exception.PortalException,
301                            com.liferay.portal.kernel.exception.SystemException {
302                    return getService()
303                                       .getPortletPreferences(ownerId, ownerType, plid, portletId);
304            }
305    
306            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
307                    long plid, java.lang.String portletId)
308                    throws com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getPortletPreferences(plid, portletId);
310            }
311    
312            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
313                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
314                    return getService().getPortletPreferencesByPlid(plid);
315            }
316    
317            public static javax.portlet.PortletPreferences getPreferences(
318                    long companyId, long ownerId, int ownerType, long plid,
319                    java.lang.String portletId)
320                    throws com.liferay.portal.kernel.exception.SystemException {
321                    return getService()
322                                       .getPreferences(companyId, ownerId, ownerType, plid,
323                            portletId);
324            }
325    
326            public static javax.portlet.PortletPreferences getPreferences(
327                    long companyId, long ownerId, int ownerType, long plid,
328                    java.lang.String portletId, java.lang.String defaultPreferences)
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService()
331                                       .getPreferences(companyId, ownerId, ownerType, plid,
332                            portletId, defaultPreferences);
333            }
334    
335            public static javax.portlet.PortletPreferences getPreferences(
336                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
337                    throws com.liferay.portal.kernel.exception.SystemException {
338                    return getService().getPreferences(portletPreferencesIds);
339            }
340    
341            public static javax.portlet.PortletPreferences getStrictPreferences(
342                    long companyId, long ownerId, int ownerType, long plid,
343                    java.lang.String portletId)
344                    throws com.liferay.portal.kernel.exception.SystemException {
345                    return getService()
346                                       .getStrictPreferences(companyId, ownerId, ownerType, plid,
347                            portletId);
348            }
349    
350            public static javax.portlet.PortletPreferences getStrictPreferences(
351                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
352                    throws com.liferay.portal.kernel.exception.SystemException {
353                    return getService().getStrictPreferences(portletPreferencesIds);
354            }
355    
356            public static com.liferay.portal.model.PortletPreferences updatePreferences(
357                    long ownerId, int ownerType, long plid, java.lang.String portletId,
358                    javax.portlet.PortletPreferences portletPreferences)
359                    throws com.liferay.portal.kernel.exception.SystemException {
360                    return getService()
361                                       .updatePreferences(ownerId, ownerType, plid, portletId,
362                            portletPreferences);
363            }
364    
365            public static com.liferay.portal.model.PortletPreferences updatePreferences(
366                    long ownerId, int ownerType, long plid, java.lang.String portletId,
367                    java.lang.String xml)
368                    throws com.liferay.portal.kernel.exception.SystemException {
369                    return getService()
370                                       .updatePreferences(ownerId, ownerType, plid, portletId, xml);
371            }
372    
373            public static PortletPreferencesLocalService getService() {
374                    if (_service == null) {
375                            _service = (PortletPreferencesLocalService)PortalBeanLocatorUtil.locate(PortletPreferencesLocalService.class.getName());
376    
377                            ReferenceRegistry.registerReference(PortletPreferencesLocalServiceUtil.class,
378                                    "_service");
379                            MethodCache.remove(PortletPreferencesLocalService.class);
380                    }
381    
382                    return _service;
383            }
384    
385            public void setService(PortletPreferencesLocalService service) {
386                    MethodCache.remove(PortletPreferencesLocalService.class);
387    
388                    _service = service;
389    
390                    ReferenceRegistry.registerReference(PortletPreferencesLocalServiceUtil.class,
391                            "_service");
392                    MethodCache.remove(PortletPreferencesLocalService.class);
393            }
394    
395            private static PortletPreferencesLocalService _service;
396    }