001    /**
002     * Copyright (c) 2000-2010 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.service;
016    
017    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
018    
019    /**
020     * 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.
021     *
022     * <p>
023     * Never modify this class directly. Add custom service methods to {@link com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
024     * </p>
025     *
026     * <p>
027     * 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.
028     * </p>
029     *
030     * @author Brian Wing Shun Chan
031     * @see PortletPreferencesLocalService
032     * @see com.liferay.portal.service.base.PortletPreferencesLocalServiceBaseImpl
033     * @see com.liferay.portal.service.impl.PortletPreferencesLocalServiceImpl
034     * @generated
035     */
036    public class PortletPreferencesLocalServiceUtil {
037            /**
038            * Adds the portlet preferences to the database. Also notifies the appropriate model listeners.
039            *
040            * @param portletPreferences the portlet preferences to add
041            * @return the portlet preferences that was added
042            * @throws SystemException if a system exception occurred
043            */
044            public static com.liferay.portal.model.PortletPreferences addPortletPreferences(
045                    com.liferay.portal.model.PortletPreferences portletPreferences)
046                    throws com.liferay.portal.kernel.exception.SystemException {
047                    return getService().addPortletPreferences(portletPreferences);
048            }
049    
050            /**
051            * Creates a new portlet preferences with the primary key. Does not add the portlet preferences to the database.
052            *
053            * @param portletPreferencesId the primary key for the new portlet preferences
054            * @return the new portlet preferences
055            */
056            public static com.liferay.portal.model.PortletPreferences createPortletPreferences(
057                    long portletPreferencesId) {
058                    return getService().createPortletPreferences(portletPreferencesId);
059            }
060    
061            /**
062            * Deletes the portlet preferences with the primary key from the database. Also notifies the appropriate model listeners.
063            *
064            * @param portletPreferencesId the primary key of the portlet preferences to delete
065            * @throws PortalException if a portlet preferences with the primary key could not be found
066            * @throws SystemException if a system exception occurred
067            */
068            public static void deletePortletPreferences(long portletPreferencesId)
069                    throws com.liferay.portal.kernel.exception.PortalException,
070                            com.liferay.portal.kernel.exception.SystemException {
071                    getService().deletePortletPreferences(portletPreferencesId);
072            }
073    
074            /**
075            * Deletes the portlet preferences from the database. Also notifies the appropriate model listeners.
076            *
077            * @param portletPreferences the portlet preferences to delete
078            * @throws SystemException if a system exception occurred
079            */
080            public static void deletePortletPreferences(
081                    com.liferay.portal.model.PortletPreferences portletPreferences)
082                    throws com.liferay.portal.kernel.exception.SystemException {
083                    getService().deletePortletPreferences(portletPreferences);
084            }
085    
086            /**
087            * Performs a dynamic query on the database and returns the matching rows.
088            *
089            * @param dynamicQuery the dynamic query to search with
090            * @return the matching rows
091            * @throws SystemException if a system exception occurred
092            */
093            @SuppressWarnings("rawtypes")
094            public static java.util.List dynamicQuery(
095                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
096                    throws com.liferay.portal.kernel.exception.SystemException {
097                    return getService().dynamicQuery(dynamicQuery);
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns a range of the matching rows.
102            *
103            * <p>
104            * 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.
105            * </p>
106            *
107            * @param dynamicQuery the dynamic query to search with
108            * @param start the lower bound of the range of model instances to return
109            * @param end the upper bound of the range of model instances to return (not inclusive)
110            * @return the range of matching rows
111            * @throws SystemException if a system exception occurred
112            */
113            @SuppressWarnings("rawtypes")
114            public static java.util.List dynamicQuery(
115                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
116                    int end) throws com.liferay.portal.kernel.exception.SystemException {
117                    return getService().dynamicQuery(dynamicQuery, start, end);
118            }
119    
120            /**
121            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
122            *
123            * <p>
124            * 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query to search with
128            * @param start the lower bound of the range of model instances to return
129            * @param end the upper bound of the range of model instances to return (not inclusive)
130            * @param orderByComparator the comparator to order the results by
131            * @return the ordered range of matching rows
132            * @throws SystemException if a system exception occurred
133            */
134            @SuppressWarnings("rawtypes")
135            public static java.util.List dynamicQuery(
136                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
137                    int end,
138                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
139                    throws com.liferay.portal.kernel.exception.SystemException {
140                    return getService()
141                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
142            }
143    
144            /**
145            * Counts the number of rows that match the dynamic query.
146            *
147            * @param dynamicQuery the dynamic query to search with
148            * @return the number of rows that match the dynamic query
149            * @throws SystemException if a system exception occurred
150            */
151            public static long dynamicQueryCount(
152                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService().dynamicQueryCount(dynamicQuery);
155            }
156    
157            /**
158            * Gets the portlet preferences with the primary key.
159            *
160            * @param portletPreferencesId the primary key of the portlet preferences to get
161            * @return the portlet preferences
162            * @throws PortalException if a portlet preferences with the primary key could not be found
163            * @throws SystemException if a system exception occurred
164            */
165            public static com.liferay.portal.model.PortletPreferences getPortletPreferences(
166                    long portletPreferencesId)
167                    throws com.liferay.portal.kernel.exception.PortalException,
168                            com.liferay.portal.kernel.exception.SystemException {
169                    return getService().getPortletPreferences(portletPreferencesId);
170            }
171    
172            /**
173            * Gets a range of all the portlet preferenceses.
174            *
175            * <p>
176            * 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.
177            * </p>
178            *
179            * @param start the lower bound of the range of portlet preferenceses to return
180            * @param end the upper bound of the range of portlet preferenceses to return (not inclusive)
181            * @return the range of portlet preferenceses
182            * @throws SystemException if a system exception occurred
183            */
184            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferenceses(
185                    int start, int end)
186                    throws com.liferay.portal.kernel.exception.SystemException {
187                    return getService().getPortletPreferenceses(start, end);
188            }
189    
190            /**
191            * Gets the number of portlet preferenceses.
192            *
193            * @return the number of portlet preferenceses
194            * @throws SystemException if a system exception occurred
195            */
196            public static int getPortletPreferencesesCount()
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getPortletPreferencesesCount();
199            }
200    
201            /**
202            * Updates the portlet preferences in the database. Also notifies the appropriate model listeners.
203            *
204            * @param portletPreferences the portlet preferences to update
205            * @return the portlet preferences that was updated
206            * @throws SystemException if a system exception occurred
207            */
208            public static com.liferay.portal.model.PortletPreferences updatePortletPreferences(
209                    com.liferay.portal.model.PortletPreferences portletPreferences)
210                    throws com.liferay.portal.kernel.exception.SystemException {
211                    return getService().updatePortletPreferences(portletPreferences);
212            }
213    
214            /**
215            * Updates the portlet preferences in the database. Also notifies the appropriate model listeners.
216            *
217            * @param portletPreferences the portlet preferences to update
218            * @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.
219            * @return the portlet preferences that was updated
220            * @throws SystemException if a system exception occurred
221            */
222            public static com.liferay.portal.model.PortletPreferences updatePortletPreferences(
223                    com.liferay.portal.model.PortletPreferences portletPreferences,
224                    boolean merge)
225                    throws com.liferay.portal.kernel.exception.SystemException {
226                    return getService().updatePortletPreferences(portletPreferences, merge);
227            }
228    
229            public static com.liferay.portal.model.PortletPreferences addPortletPreferences(
230                    long companyId, long ownerId, int ownerType, long plid,
231                    java.lang.String portletId, com.liferay.portal.model.Portlet portlet,
232                    java.lang.String defaultPreferences)
233                    throws com.liferay.portal.kernel.exception.SystemException {
234                    return getService()
235                                       .addPortletPreferences(companyId, ownerId, ownerType, plid,
236                            portletId, portlet, defaultPreferences);
237            }
238    
239            public static void deletePortletPreferences(long ownerId, int ownerType,
240                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
241                    getService().deletePortletPreferences(ownerId, ownerType, plid);
242            }
243    
244            public static void deletePortletPreferences(long ownerId, int ownerType,
245                    long plid, java.lang.String portletId)
246                    throws com.liferay.portal.kernel.exception.PortalException,
247                            com.liferay.portal.kernel.exception.SystemException {
248                    getService()
249                            .deletePortletPreferences(ownerId, ownerType, plid, portletId);
250            }
251    
252            public static javax.portlet.PortletPreferences getDefaultPreferences(
253                    long companyId, java.lang.String portletId)
254                    throws com.liferay.portal.kernel.exception.SystemException {
255                    return getService().getDefaultPreferences(companyId, portletId);
256            }
257    
258            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences()
259                    throws com.liferay.portal.kernel.exception.SystemException {
260                    return getService().getPortletPreferences();
261            }
262    
263            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
264                    long plid, java.lang.String portletId)
265                    throws com.liferay.portal.kernel.exception.SystemException {
266                    return getService().getPortletPreferences(plid, portletId);
267            }
268    
269            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferences(
270                    long ownerId, int ownerType, long plid)
271                    throws com.liferay.portal.kernel.exception.SystemException {
272                    return getService().getPortletPreferences(ownerId, ownerType, plid);
273            }
274    
275            public static com.liferay.portal.model.PortletPreferences getPortletPreferences(
276                    long ownerId, int ownerType, long plid, java.lang.String portletId)
277                    throws com.liferay.portal.kernel.exception.PortalException,
278                            com.liferay.portal.kernel.exception.SystemException {
279                    return getService()
280                                       .getPortletPreferences(ownerId, ownerType, plid, portletId);
281            }
282    
283            public static java.util.List<com.liferay.portal.model.PortletPreferences> getPortletPreferencesByPlid(
284                    long plid) throws com.liferay.portal.kernel.exception.SystemException {
285                    return getService().getPortletPreferencesByPlid(plid);
286            }
287    
288            public static javax.portlet.PortletPreferences getPreferences(
289                    com.liferay.portal.model.PortletPreferencesIds portletPreferencesIds)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().getPreferences(portletPreferencesIds);
292            }
293    
294            public static javax.portlet.PortletPreferences getPreferences(
295                    long companyId, long ownerId, int ownerType, long plid,
296                    java.lang.String portletId)
297                    throws com.liferay.portal.kernel.exception.SystemException {
298                    return getService()
299                                       .getPreferences(companyId, ownerId, ownerType, plid,
300                            portletId);
301            }
302    
303            public static javax.portlet.PortletPreferences getPreferences(
304                    long companyId, long ownerId, int ownerType, long plid,
305                    java.lang.String portletId, java.lang.String defaultPreferences)
306                    throws com.liferay.portal.kernel.exception.SystemException {
307                    return getService()
308                                       .getPreferences(companyId, ownerId, ownerType, plid,
309                            portletId, defaultPreferences);
310            }
311    
312            public static com.liferay.portal.model.PortletPreferences updatePreferences(
313                    long ownerId, int ownerType, long plid, java.lang.String portletId,
314                    javax.portlet.PortletPreferences preferences)
315                    throws com.liferay.portal.kernel.exception.SystemException {
316                    return getService()
317                                       .updatePreferences(ownerId, ownerType, plid, portletId,
318                            preferences);
319            }
320    
321            public static com.liferay.portal.model.PortletPreferences updatePreferences(
322                    long ownerId, int ownerType, long plid, java.lang.String portletId,
323                    java.lang.String xml)
324                    throws com.liferay.portal.kernel.exception.SystemException {
325                    return getService()
326                                       .updatePreferences(ownerId, ownerType, plid, portletId, xml);
327            }
328    
329            public static PortletPreferencesLocalService getService() {
330                    if (_service == null) {
331                            _service = (PortletPreferencesLocalService)PortalBeanLocatorUtil.locate(PortletPreferencesLocalService.class.getName());
332                    }
333    
334                    return _service;
335            }
336    
337            public void setService(PortletPreferencesLocalService service) {
338                    _service = service;
339            }
340    
341            private static PortletPreferencesLocalService _service;
342    }