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