001    /**
002     * Copyright (c) 2000-2012 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            public static com.liferay.portal.model.PortletPreferences fetchPortletPreferences(
162                    long portletPreferencesId)
163                    throws com.liferay.portal.kernel.exception.SystemException {
164                    return getService().fetchPortletPreferences(portletPreferencesId);
165            }
166    
167            /**
168            * Returns the portlet preferences with the primary key.
169            *
170            * @param portletPreferencesId the primary key of the portlet preferences
171            * @return the portlet preferences
172            * @throws PortalException if a portlet preferences with the primary key could not be found
173            * @throws SystemException if a system exception occurred
174            */
175            public static com.liferay.portal.model.PortletPreferences getPortletPreferences(
176                    long portletPreferencesId)
177                    throws com.liferay.portal.kernel.exception.PortalException,
178                            com.liferay.portal.kernel.exception.SystemException {
179                    return getService().getPortletPreferences(portletPreferencesId);
180            }
181    
182            public static com.liferay.portal.model.PersistedModel getPersistedModel(
183                    java.io.Serializable primaryKeyObj)
184                    throws com.liferay.portal.kernel.exception.PortalException,
185                            com.liferay.portal.kernel.exception.SystemException {
186                    return getService().getPersistedModel(primaryKeyObj);
187            }
188    
189            /**
190            * Returns a range of all the portlet preferenceses.
191            *
192            * <p>
193            * 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.
194            * </p>
195            *
196            * @param start the lower bound of the range of portlet preferenceses
197            * @param end the upper bound of the range of portlet preferenceses (not inclusive)
198            * @return the range of portlet preferenceses
199            * @throws SystemException if a system exception occurred
200            */
201            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
202                    int start, int end)
203                    throws com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getPortletPreferenceses(start, end);
205            }
206    
207            /**
208            * Returns the number of portlet preferenceses.
209            *
210            * @return the number of portlet preferenceses
211            * @throws SystemException if a system exception occurred
212            */
213            public static int getPortletPreferencesesCount()
214                    throws com.liferay.portal.kernel.exception.SystemException {
215                    return getService().getPortletPreferencesesCount();
216            }
217    
218            /**
219            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
220            *
221            * @param portletPreferences the portlet preferences
222            * @return the portlet preferences that was updated
223            * @throws SystemException if a system exception occurred
224            */
225            public static com.liferay.portal.model.PortletPreferences updatePortletPreferences(
226                    com.liferay.portal.model.PortletPreferences portletPreferences)
227                    throws com.liferay.portal.kernel.exception.SystemException {
228                    return getService().updatePortletPreferences(portletPreferences);
229            }
230    
231            /**
232            * Updates the portlet preferences in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
233            *
234            * @param portletPreferences the portlet preferences
235            * @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.
236            * @return the portlet preferences that was updated
237            * @throws SystemException if a system exception occurred
238            */
239            public static com.liferay.portal.model.PortletPreferences updatePortletPreferences(
240                    com.liferay.portal.model.PortletPreferences portletPreferences,
241                    boolean merge)
242                    throws com.liferay.portal.kernel.exception.SystemException {
243                    return getService().updatePortletPreferences(portletPreferences, merge);
244            }
245    
246            /**
247            * Returns the Spring bean ID for this bean.
248            *
249            * @return the Spring bean ID for this bean
250            */
251            public static java.lang.String getBeanIdentifier() {
252                    return getService().getBeanIdentifier();
253            }
254    
255            /**
256            * Sets the Spring bean ID for this bean.
257            *
258            * @param beanIdentifier the Spring bean ID for this bean
259            */
260            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
261                    getService().setBeanIdentifier(beanIdentifier);
262            }
263    
264            public static com.liferay.portal.model.PortletPreferences addPortletPreferences(
265                    long companyId, long ownerId, int ownerType, long plid,
266                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
267                    java.lang.String defaultPreferences)
268                    throws com.liferay.portal.kernel.exception.SystemException {
269                    return getService()
270                                       .addPortletPreferences(companyId, ownerId, ownerType, plid,
271                            portletId, portlet, defaultPreferences);
272            }
273    
274            public static void deletePortletPreferences(long ownerId, int ownerType,
275                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
276                    getService().deletePortletPreferences(ownerId, ownerType, plid);
277            }
278    
279            public static void deletePortletPreferences(long ownerId, int ownerType,
280                    long plid, java.lang.String portletId)
281                    throws com.liferay.portal.kernel.exception.PortalException,
282                            com.liferay.portal.kernel.exception.SystemException {
283                    getService()
284                            .deletePortletPreferences(ownerId, ownerType, plid, portletId);
285            }
286    
287            public static javax.portlet.PortletPreferences getDefaultPreferences(
288                    long companyId, java.lang.String portletId)
289                    throws com.liferay.portal.kernel.exception.SystemException {
290                    return getService().getDefaultPreferences(companyId, portletId);
291            }
292    
293            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences()
294                    throws com.liferay.portal.kernel.exception.SystemException {
295                    return getService().getPortletPreferences();
296            }
297    
298            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
299                    int ownerType, long plid, java.lang.String portletId)
300                    throws com.liferay.portal.kernel.exception.SystemException {
301                    return getService().getPortletPreferences(ownerType, plid, portletId);
302            }
303    
304            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
305                    long ownerId, int ownerType, long plid)
306                    throws com.liferay.portal.kernel.exception.SystemException {
307                    return getService().getPortletPreferences(ownerId, ownerType, plid);
308            }
309    
310            public static com.liferay.portal.model.PortletPreferences getPortletPreferences(
311                    long ownerId, int ownerType, long plid, java.lang.String portletId)
312                    throws com.liferay.portal.kernel.exception.PortalException,
313                            com.liferay.portal.kernel.exception.SystemException {
314                    return getService()
315                                       .getPortletPreferences(ownerId, ownerType, plid, portletId);
316            }
317    
318            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
319                    long companyId, long groupId, long ownerId, int ownerType,
320                    java.lang.String portletId, boolean privateLayout)
321                    throws com.liferay.portal.kernel.exception.SystemException {
322                    return getService()
323                                       .getPortletPreferences(companyId, groupId, ownerId,
324                            ownerType, portletId, privateLayout);
325            }
326    
327            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
328                    long plid, java.lang.String portletId)
329                    throws com.liferay.portal.kernel.exception.SystemException {
330                    return getService().getPortletPreferences(plid, portletId);
331            }
332    
333            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
334                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
335                    return getService().getPortletPreferencesByPlid(plid);
336            }
337    
338            public static javax.portlet.PortletPreferences getPreferences(
339                    long companyId, long ownerId, int ownerType, long plid,
340                    java.lang.String portletId)
341                    throws com.liferay.portal.kernel.exception.SystemException {
342                    return getService()
343                                       .getPreferences(companyId, ownerId, ownerType, plid,
344                            portletId);
345            }
346    
347            public static javax.portlet.PortletPreferences getPreferences(
348                    long companyId, long ownerId, int ownerType, long plid,
349                    java.lang.String portletId, java.lang.String defaultPreferences)
350                    throws com.liferay.portal.kernel.exception.SystemException {
351                    return getService()
352                                       .getPreferences(companyId, ownerId, ownerType, plid,
353                            portletId, defaultPreferences);
354            }
355    
356            public static javax.portlet.PortletPreferences getPreferences(
357                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
358                    throws com.liferay.portal.kernel.exception.SystemException {
359                    return getService().getPreferences(portletPreferencesIds);
360            }
361    
362            public static javax.portlet.PortletPreferences getStrictPreferences(
363                    long companyId, long ownerId, int ownerType, long plid,
364                    java.lang.String portletId)
365                    throws com.liferay.portal.kernel.exception.SystemException {
366                    return getService()
367                                       .getStrictPreferences(companyId, ownerId, ownerType, plid,
368                            portletId);
369            }
370    
371            public static javax.portlet.PortletPreferences getStrictPreferences(
372                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
373                    throws com.liferay.portal.kernel.exception.SystemException {
374                    return getService().getStrictPreferences(portletPreferencesIds);
375            }
376    
377            public static com.liferay.portal.model.PortletPreferences updatePreferences(
378                    long ownerId, int ownerType, long plid, java.lang.String portletId,
379                    javax.portlet.PortletPreferences portletPreferences)
380                    throws com.liferay.portal.kernel.exception.SystemException {
381                    return getService()
382                                       .updatePreferences(ownerId, ownerType, plid, portletId,
383                            portletPreferences);
384            }
385    
386            public static com.liferay.portal.model.PortletPreferences updatePreferences(
387                    long ownerId, int ownerType, long plid, java.lang.String portletId,
388                    java.lang.String xml)
389                    throws com.liferay.portal.kernel.exception.SystemException {
390                    return getService()
391                                       .updatePreferences(ownerId, ownerType, plid, portletId, xml);
392            }
393    
394            public static PortletPreferencesLocalService getService() {
395                    if (_service == null) {
396                            _service = (PortletPreferencesLocalService)PortalBeanLocatorUtil.locate(PortletPreferencesLocalService.class.getName());
397    
398                            ReferenceRegistry.registerReference(PortletPreferencesLocalServiceUtil.class,
399                                    "_service");
400                            MethodCache.remove(PortletPreferencesLocalService.class);
401                    }
402    
403                    return _service;
404            }
405    
406            public void setService(PortletPreferencesLocalService service) {
407                    MethodCache.remove(PortletPreferencesLocalService.class);
408    
409                    _service = service;
410    
411                    ReferenceRegistry.registerReference(PortletPreferencesLocalServiceUtil.class,
412                            "_service");
413                    MethodCache.remove(PortletPreferencesLocalService.class);
414            }
415    
416            private static PortletPreferencesLocalService _service;
417    }