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.portlet.ratings.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 ratings entry local service. This utility wraps {@link com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl} 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 RatingsEntryLocalService
030     * @see com.liferay.portlet.ratings.service.base.RatingsEntryLocalServiceBaseImpl
031     * @see com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl
032     * @generated
033     */
034    public class RatingsEntryLocalServiceUtil {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
039             */
040    
041            /**
042            * Adds the ratings entry to the database. Also notifies the appropriate model listeners.
043            *
044            * @param ratingsEntry the ratings entry
045            * @return the ratings entry that was added
046            * @throws SystemException if a system exception occurred
047            */
048            public static com.liferay.portlet.ratings.model.RatingsEntry addRatingsEntry(
049                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry)
050                    throws com.liferay.portal.kernel.exception.SystemException {
051                    return getService().addRatingsEntry(ratingsEntry);
052            }
053    
054            /**
055            * Creates a new ratings entry with the primary key. Does not add the ratings entry to the database.
056            *
057            * @param entryId the primary key for the new ratings entry
058            * @return the new ratings entry
059            */
060            public static com.liferay.portlet.ratings.model.RatingsEntry createRatingsEntry(
061                    long entryId) {
062                    return getService().createRatingsEntry(entryId);
063            }
064    
065            /**
066            * Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param entryId the primary key of the ratings entry
069            * @throws PortalException if a ratings entry with the primary key could not be found
070            * @throws SystemException if a system exception occurred
071            */
072            public static void deleteRatingsEntry(long entryId)
073                    throws com.liferay.portal.kernel.exception.PortalException,
074                            com.liferay.portal.kernel.exception.SystemException {
075                    getService().deleteRatingsEntry(entryId);
076            }
077    
078            /**
079            * Deletes the ratings entry from the database. Also notifies the appropriate model listeners.
080            *
081            * @param ratingsEntry the ratings entry
082            * @throws SystemException if a system exception occurred
083            */
084            public static void deleteRatingsEntry(
085                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry)
086                    throws com.liferay.portal.kernel.exception.SystemException {
087                    getService().deleteRatingsEntry(ratingsEntry);
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 ratings entry with the primary key.
163            *
164            * @param entryId the primary key of the ratings entry
165            * @return the ratings entry
166            * @throws PortalException if a ratings entry with the primary key could not be found
167            * @throws SystemException if a system exception occurred
168            */
169            public static com.liferay.portlet.ratings.model.RatingsEntry getRatingsEntry(
170                    long entryId)
171                    throws com.liferay.portal.kernel.exception.PortalException,
172                            com.liferay.portal.kernel.exception.SystemException {
173                    return getService().getRatingsEntry(entryId);
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 ratings entries.
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 ratings entries
191            * @param end the upper bound of the range of ratings entries (not inclusive)
192            * @return the range of ratings entries
193            * @throws SystemException if a system exception occurred
194            */
195            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getRatingsEntries(
196                    int start, int end)
197                    throws com.liferay.portal.kernel.exception.SystemException {
198                    return getService().getRatingsEntries(start, end);
199            }
200    
201            /**
202            * Returns the number of ratings entries.
203            *
204            * @return the number of ratings entries
205            * @throws SystemException if a system exception occurred
206            */
207            public static int getRatingsEntriesCount()
208                    throws com.liferay.portal.kernel.exception.SystemException {
209                    return getService().getRatingsEntriesCount();
210            }
211    
212            /**
213            * Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
214            *
215            * @param ratingsEntry the ratings entry
216            * @return the ratings entry that was updated
217            * @throws SystemException if a system exception occurred
218            */
219            public static com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry(
220                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry)
221                    throws com.liferay.portal.kernel.exception.SystemException {
222                    return getService().updateRatingsEntry(ratingsEntry);
223            }
224    
225            /**
226            * Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
227            *
228            * @param ratingsEntry the ratings entry
229            * @param merge whether to merge the ratings entry 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 ratings entry that was updated
231            * @throws SystemException if a system exception occurred
232            */
233            public static com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry(
234                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry,
235                    boolean merge)
236                    throws com.liferay.portal.kernel.exception.SystemException {
237                    return getService().updateRatingsEntry(ratingsEntry, 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 void deleteEntry(long userId, java.lang.String className,
259                    long classPK)
260                    throws com.liferay.portal.kernel.exception.PortalException,
261                            com.liferay.portal.kernel.exception.SystemException {
262                    getService().deleteEntry(userId, className, classPK);
263            }
264    
265            public static com.liferay.portlet.ratings.model.RatingsEntry fetchEntry(
266                    long userId, java.lang.String className, long classPK)
267                    throws com.liferay.portal.kernel.exception.SystemException {
268                    return getService().fetchEntry(userId, className, classPK);
269            }
270    
271            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
272                    long userId, java.lang.String className,
273                    java.util.List<java.lang.Long> classPKs)
274                    throws com.liferay.portal.kernel.exception.SystemException {
275                    return getService().getEntries(userId, className, classPKs);
276            }
277    
278            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
279                    java.lang.String className, long classPK)
280                    throws com.liferay.portal.kernel.exception.SystemException {
281                    return getService().getEntries(className, classPK);
282            }
283    
284            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
285                    java.lang.String className, long classPK, double score)
286                    throws com.liferay.portal.kernel.exception.SystemException {
287                    return getService().getEntries(className, classPK, score);
288            }
289    
290            public static int getEntriesCount(java.lang.String className, long classPK,
291                    double score)
292                    throws com.liferay.portal.kernel.exception.SystemException {
293                    return getService().getEntriesCount(className, classPK, score);
294            }
295    
296            public static com.liferay.portlet.ratings.model.RatingsEntry getEntry(
297                    long userId, java.lang.String className, long classPK)
298                    throws com.liferay.portal.kernel.exception.PortalException,
299                            com.liferay.portal.kernel.exception.SystemException {
300                    return getService().getEntry(userId, className, classPK);
301            }
302    
303            public static com.liferay.portlet.ratings.model.RatingsEntry updateEntry(
304                    long userId, java.lang.String className, long classPK, double score,
305                    com.liferay.portal.service.ServiceContext serviceContext)
306                    throws com.liferay.portal.kernel.exception.PortalException,
307                            com.liferay.portal.kernel.exception.SystemException {
308                    return getService()
309                                       .updateEntry(userId, className, classPK, score,
310                            serviceContext);
311            }
312    
313            public static RatingsEntryLocalService getService() {
314                    if (_service == null) {
315                            _service = (RatingsEntryLocalService)PortalBeanLocatorUtil.locate(RatingsEntryLocalService.class.getName());
316    
317                            ReferenceRegistry.registerReference(RatingsEntryLocalServiceUtil.class,
318                                    "_service");
319                            MethodCache.remove(RatingsEntryLocalService.class);
320                    }
321    
322                    return _service;
323            }
324    
325            public void setService(RatingsEntryLocalService service) {
326                    MethodCache.remove(RatingsEntryLocalService.class);
327    
328                    _service = service;
329    
330                    ReferenceRegistry.registerReference(RatingsEntryLocalServiceUtil.class,
331                            "_service");
332                    MethodCache.remove(RatingsEntryLocalService.class);
333            }
334    
335            private static RatingsEntryLocalService _service;
336    }