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.portlet.ratings.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
020    import com.liferay.portal.kernel.util.ReferenceRegistry;
021    
022    /**
023     * Provides the local service utility for RatingsEntry. This utility wraps
024     * {@link com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl} and is the
025     * primary access point for service operations in application layer code running
026     * on the local server. Methods of this service will not have security checks
027     * based on the propagated JAAS credentials because this service can only be
028     * accessed from within the same VM.
029     *
030     * @author Brian Wing Shun Chan
031     * @see RatingsEntryLocalService
032     * @see com.liferay.portlet.ratings.service.base.RatingsEntryLocalServiceBaseImpl
033     * @see com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl
034     * @generated
035     */
036    @ProviderType
037    public class RatingsEntryLocalServiceUtil {
038            /*
039             * NOTE FOR DEVELOPERS:
040             *
041             * 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.
042             */
043    
044            /**
045            * Adds the ratings entry to the database. Also notifies the appropriate model listeners.
046            *
047            * @param ratingsEntry the ratings entry
048            * @return the ratings entry that was added
049            * @throws SystemException if a system exception occurred
050            */
051            public static com.liferay.portlet.ratings.model.RatingsEntry addRatingsEntry(
052                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry)
053                    throws com.liferay.portal.kernel.exception.SystemException {
054                    return getService().addRatingsEntry(ratingsEntry);
055            }
056    
057            /**
058            * Creates a new ratings entry with the primary key. Does not add the ratings entry to the database.
059            *
060            * @param entryId the primary key for the new ratings entry
061            * @return the new ratings entry
062            */
063            public static com.liferay.portlet.ratings.model.RatingsEntry createRatingsEntry(
064                    long entryId) {
065                    return getService().createRatingsEntry(entryId);
066            }
067    
068            /**
069            * Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners.
070            *
071            * @param entryId the primary key of the ratings entry
072            * @return the ratings entry that was removed
073            * @throws PortalException if a ratings entry with the primary key could not be found
074            * @throws SystemException if a system exception occurred
075            */
076            public static com.liferay.portlet.ratings.model.RatingsEntry deleteRatingsEntry(
077                    long entryId)
078                    throws com.liferay.portal.kernel.exception.PortalException,
079                            com.liferay.portal.kernel.exception.SystemException {
080                    return getService().deleteRatingsEntry(entryId);
081            }
082    
083            /**
084            * Deletes the ratings entry from the database. Also notifies the appropriate model listeners.
085            *
086            * @param ratingsEntry the ratings entry
087            * @return the ratings entry that was removed
088            * @throws SystemException if a system exception occurred
089            */
090            public static com.liferay.portlet.ratings.model.RatingsEntry deleteRatingsEntry(
091                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry)
092                    throws com.liferay.portal.kernel.exception.SystemException {
093                    return getService().deleteRatingsEntry(ratingsEntry);
094            }
095    
096            public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
097                    return getService().dynamicQuery();
098            }
099    
100            /**
101            * Performs a dynamic query on the database and returns the matching rows.
102            *
103            * @param dynamicQuery the dynamic query
104            * @return the matching rows
105            * @throws SystemException if a system exception occurred
106            */
107            @SuppressWarnings("rawtypes")
108            public static java.util.List dynamicQuery(
109                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
110                    throws com.liferay.portal.kernel.exception.SystemException {
111                    return getService().dynamicQuery(dynamicQuery);
112            }
113    
114            /**
115            * Performs a dynamic query on the database and returns a range of the matching rows.
116            *
117            * <p>
118            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
119            * </p>
120            *
121            * @param dynamicQuery the dynamic query
122            * @param start the lower bound of the range of model instances
123            * @param end the upper bound of the range of model instances (not inclusive)
124            * @return the range of matching rows
125            * @throws SystemException if a system exception occurred
126            */
127            @SuppressWarnings("rawtypes")
128            public static java.util.List dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end) throws com.liferay.portal.kernel.exception.SystemException {
131                    return getService().dynamicQuery(dynamicQuery, start, end);
132            }
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            * @throws SystemException if a system exception occurred
147            */
148            @SuppressWarnings("rawtypes")
149            public static java.util.List dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException {
154                    return getService()
155                                       .dynamicQuery(dynamicQuery, start, end, orderByComparator);
156            }
157    
158            /**
159            * Returns the number of rows that match the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @return the number of rows that match the dynamic query
163            * @throws SystemException if a system exception occurred
164            */
165            public static long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
167                    throws com.liferay.portal.kernel.exception.SystemException {
168                    return getService().dynamicQueryCount(dynamicQuery);
169            }
170    
171            /**
172            * Returns the number of rows that match the dynamic query.
173            *
174            * @param dynamicQuery the dynamic query
175            * @param projection the projection to apply to the query
176            * @return the number of rows that match the dynamic query
177            * @throws SystemException if a system exception occurred
178            */
179            public static long dynamicQueryCount(
180                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
181                    com.liferay.portal.kernel.dao.orm.Projection projection)
182                    throws com.liferay.portal.kernel.exception.SystemException {
183                    return getService().dynamicQueryCount(dynamicQuery, projection);
184            }
185    
186            public static com.liferay.portlet.ratings.model.RatingsEntry fetchRatingsEntry(
187                    long entryId)
188                    throws com.liferay.portal.kernel.exception.SystemException {
189                    return getService().fetchRatingsEntry(entryId);
190            }
191    
192            /**
193            * Returns the ratings entry with the primary key.
194            *
195            * @param entryId the primary key of the ratings entry
196            * @return the ratings entry
197            * @throws PortalException if a ratings entry with the primary key could not be found
198            * @throws SystemException if a system exception occurred
199            */
200            public static com.liferay.portlet.ratings.model.RatingsEntry getRatingsEntry(
201                    long entryId)
202                    throws com.liferay.portal.kernel.exception.PortalException,
203                            com.liferay.portal.kernel.exception.SystemException {
204                    return getService().getRatingsEntry(entryId);
205            }
206    
207            public static com.liferay.portal.model.PersistedModel getPersistedModel(
208                    java.io.Serializable primaryKeyObj)
209                    throws com.liferay.portal.kernel.exception.PortalException,
210                            com.liferay.portal.kernel.exception.SystemException {
211                    return getService().getPersistedModel(primaryKeyObj);
212            }
213    
214            /**
215            * Returns a range of all the ratings entries.
216            *
217            * <p>
218            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
219            * </p>
220            *
221            * @param start the lower bound of the range of ratings entries
222            * @param end the upper bound of the range of ratings entries (not inclusive)
223            * @return the range of ratings entries
224            * @throws SystemException if a system exception occurred
225            */
226            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getRatingsEntries(
227                    int start, int end)
228                    throws com.liferay.portal.kernel.exception.SystemException {
229                    return getService().getRatingsEntries(start, end);
230            }
231    
232            /**
233            * Returns the number of ratings entries.
234            *
235            * @return the number of ratings entries
236            * @throws SystemException if a system exception occurred
237            */
238            public static int getRatingsEntriesCount()
239                    throws com.liferay.portal.kernel.exception.SystemException {
240                    return getService().getRatingsEntriesCount();
241            }
242    
243            /**
244            * Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
245            *
246            * @param ratingsEntry the ratings entry
247            * @return the ratings entry that was updated
248            * @throws SystemException if a system exception occurred
249            */
250            public static com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry(
251                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry)
252                    throws com.liferay.portal.kernel.exception.SystemException {
253                    return getService().updateRatingsEntry(ratingsEntry);
254            }
255    
256            /**
257            * Returns the Spring bean ID for this bean.
258            *
259            * @return the Spring bean ID for this bean
260            */
261            public static java.lang.String getBeanIdentifier() {
262                    return getService().getBeanIdentifier();
263            }
264    
265            /**
266            * Sets the Spring bean ID for this bean.
267            *
268            * @param beanIdentifier the Spring bean ID for this bean
269            */
270            public static void setBeanIdentifier(java.lang.String beanIdentifier) {
271                    getService().setBeanIdentifier(beanIdentifier);
272            }
273    
274            public static void deleteEntry(long userId, java.lang.String className,
275                    long classPK)
276                    throws com.liferay.portal.kernel.exception.PortalException,
277                            com.liferay.portal.kernel.exception.SystemException {
278                    getService().deleteEntry(userId, className, classPK);
279            }
280    
281            public static com.liferay.portlet.ratings.model.RatingsEntry fetchEntry(
282                    long userId, java.lang.String className, long classPK)
283                    throws com.liferay.portal.kernel.exception.SystemException {
284                    return getService().fetchEntry(userId, className, classPK);
285            }
286    
287            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
288                    long userId, java.lang.String className,
289                    java.util.List<java.lang.Long> classPKs)
290                    throws com.liferay.portal.kernel.exception.SystemException {
291                    return getService().getEntries(userId, className, classPKs);
292            }
293    
294            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
295                    java.lang.String className, long classPK)
296                    throws com.liferay.portal.kernel.exception.SystemException {
297                    return getService().getEntries(className, classPK);
298            }
299    
300            public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
301                    java.lang.String className, long classPK, double score)
302                    throws com.liferay.portal.kernel.exception.SystemException {
303                    return getService().getEntries(className, classPK, score);
304            }
305    
306            public static int getEntriesCount(java.lang.String className, long classPK,
307                    double score)
308                    throws com.liferay.portal.kernel.exception.SystemException {
309                    return getService().getEntriesCount(className, classPK, score);
310            }
311    
312            public static com.liferay.portlet.ratings.model.RatingsEntry getEntry(
313                    long userId, java.lang.String className, long classPK)
314                    throws com.liferay.portal.kernel.exception.PortalException,
315                            com.liferay.portal.kernel.exception.SystemException {
316                    return getService().getEntry(userId, className, classPK);
317            }
318    
319            public static com.liferay.portlet.ratings.model.RatingsEntry updateEntry(
320                    long userId, java.lang.String className, long classPK, double score,
321                    com.liferay.portal.service.ServiceContext serviceContext)
322                    throws com.liferay.portal.kernel.exception.PortalException,
323                            com.liferay.portal.kernel.exception.SystemException {
324                    return getService()
325                                       .updateEntry(userId, className, classPK, score,
326                            serviceContext);
327            }
328    
329            public static RatingsEntryLocalService getService() {
330                    if (_service == null) {
331                            _service = (RatingsEntryLocalService)PortalBeanLocatorUtil.locate(RatingsEntryLocalService.class.getName());
332    
333                            ReferenceRegistry.registerReference(RatingsEntryLocalServiceUtil.class,
334                                    "_service");
335                    }
336    
337                    return _service;
338            }
339    
340            /**
341             * @deprecated As of 6.2.0
342             */
343            public void setService(RatingsEntryLocalService service) {
344            }
345    
346            private static RatingsEntryLocalService _service;
347    }