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