001    /**
002     * Copyright (c) 2000-present 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.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for RatingsEntry. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see RatingsEntryLocalServiceUtil
036     * @see com.liferay.portlet.ratings.service.base.RatingsEntryLocalServiceBaseImpl
037     * @see com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface RatingsEntryLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link RatingsEntryLocalServiceUtil} to access the ratings entry local service. Add custom service methods to {@link com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the ratings entry to the database. Also notifies the appropriate model listeners.
053            *
054            * @param ratingsEntry the ratings entry
055            * @return the ratings entry that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.ratings.model.RatingsEntry addRatingsEntry(
059                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry);
060    
061            /**
062            * Creates a new ratings entry with the primary key. Does not add the ratings entry to the database.
063            *
064            * @param entryId the primary key for the new ratings entry
065            * @return the new ratings entry
066            */
067            public com.liferay.portlet.ratings.model.RatingsEntry createRatingsEntry(
068                    long entryId);
069    
070            public void deleteEntry(long userId, java.lang.String className,
071                    long classPK)
072                    throws com.liferay.portal.kernel.exception.PortalException;
073    
074            /**
075            * @throws PortalException
076            */
077            @Override
078            public com.liferay.portal.model.PersistedModel deletePersistedModel(
079                    com.liferay.portal.model.PersistedModel persistedModel)
080                    throws com.liferay.portal.kernel.exception.PortalException;
081    
082            /**
083            * Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners.
084            *
085            * @param entryId the primary key of the ratings entry
086            * @return the ratings entry that was removed
087            * @throws PortalException if a ratings entry with the primary key could not be found
088            */
089            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
090            public com.liferay.portlet.ratings.model.RatingsEntry deleteRatingsEntry(
091                    long entryId)
092                    throws com.liferay.portal.kernel.exception.PortalException;
093    
094            /**
095            * Deletes the ratings entry from the database. Also notifies the appropriate model listeners.
096            *
097            * @param ratingsEntry the ratings entry
098            * @return the ratings entry that was removed
099            */
100            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
101            public com.liferay.portlet.ratings.model.RatingsEntry deleteRatingsEntry(
102                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry);
103    
104            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
105    
106            /**
107            * Performs a dynamic query on the database and returns the matching rows.
108            *
109            * @param dynamicQuery the dynamic query
110            * @return the matching rows
111            */
112            public <T> java.util.List<T> dynamicQuery(
113                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
114    
115            /**
116            * Performs a dynamic query on the database and returns a range of the matching rows.
117            *
118            * <p>
119            * 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.
120            * </p>
121            *
122            * @param dynamicQuery the dynamic query
123            * @param start the lower bound of the range of model instances
124            * @param end the upper bound of the range of model instances (not inclusive)
125            * @return the range of matching rows
126            */
127            public <T> java.util.List<T> dynamicQuery(
128                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
129                    int end);
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            */
144            public <T> java.util.List<T> dynamicQuery(
145                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
146                    int end,
147                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
148    
149            /**
150            * Returns the number of rows matching the dynamic query.
151            *
152            * @param dynamicQuery the dynamic query
153            * @return the number of rows matching the dynamic query
154            */
155            public long dynamicQueryCount(
156                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
157    
158            /**
159            * Returns the number of rows matching the dynamic query.
160            *
161            * @param dynamicQuery the dynamic query
162            * @param projection the projection to apply to the query
163            * @return the number of rows matching the dynamic query
164            */
165            public long dynamicQueryCount(
166                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
167                    com.liferay.portal.kernel.dao.orm.Projection projection);
168    
169            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
170            public com.liferay.portlet.ratings.model.RatingsEntry fetchEntry(
171                    long userId, java.lang.String className, long classPK);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portlet.ratings.model.RatingsEntry fetchRatingsEntry(
175                    long entryId);
176    
177            /**
178            * Returns the ratings entry with the matching UUID and company.
179            *
180            * @param uuid the ratings entry's UUID
181            * @param companyId the primary key of the company
182            * @return the matching ratings entry, or <code>null</code> if a matching ratings entry could not be found
183            */
184            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
185            public com.liferay.portlet.ratings.model.RatingsEntry fetchRatingsEntryByUuidAndCompanyId(
186                    java.lang.String uuid, long companyId);
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
190    
191            /**
192            * Returns the Spring bean ID for this bean.
193            *
194            * @return the Spring bean ID for this bean
195            */
196            public java.lang.String getBeanIdentifier();
197    
198            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
199            public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
200                    java.lang.String className, long classPK);
201    
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
204                    java.lang.String className, long classPK, double score);
205    
206            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
207            public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries(
208                    long userId, java.lang.String className,
209                    java.util.List<java.lang.Long> classPKs);
210    
211            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
212            public int getEntriesCount(java.lang.String className, long classPK,
213                    double score);
214    
215            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
216            public com.liferay.portlet.ratings.model.RatingsEntry getEntry(
217                    long userId, java.lang.String className, long classPK)
218                    throws com.liferay.portal.kernel.exception.PortalException;
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
222                    com.liferay.portal.kernel.lar.PortletDataContext portletDataContext);
223    
224            @Override
225            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
226            public com.liferay.portal.model.PersistedModel getPersistedModel(
227                    java.io.Serializable primaryKeyObj)
228                    throws com.liferay.portal.kernel.exception.PortalException;
229    
230            /**
231            * Returns a range of all the ratings entries.
232            *
233            * <p>
234            * 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.
235            * </p>
236            *
237            * @param start the lower bound of the range of ratings entries
238            * @param end the upper bound of the range of ratings entries (not inclusive)
239            * @return the range of ratings entries
240            */
241            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
242            public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getRatingsEntries(
243                    int start, int end);
244    
245            /**
246            * Returns the number of ratings entries.
247            *
248            * @return the number of ratings entries
249            */
250            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
251            public int getRatingsEntriesCount();
252    
253            /**
254            * Returns the ratings entry with the primary key.
255            *
256            * @param entryId the primary key of the ratings entry
257            * @return the ratings entry
258            * @throws PortalException if a ratings entry with the primary key could not be found
259            */
260            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
261            public com.liferay.portlet.ratings.model.RatingsEntry getRatingsEntry(
262                    long entryId)
263                    throws com.liferay.portal.kernel.exception.PortalException;
264    
265            /**
266            * Returns the ratings entry with the matching UUID and company.
267            *
268            * @param uuid the ratings entry's UUID
269            * @param companyId the primary key of the company
270            * @return the matching ratings entry
271            * @throws PortalException if a matching ratings entry could not be found
272            */
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public com.liferay.portlet.ratings.model.RatingsEntry getRatingsEntryByUuidAndCompanyId(
275                    java.lang.String uuid, long companyId)
276                    throws com.liferay.portal.kernel.exception.PortalException;
277    
278            /**
279            * Sets the Spring bean ID for this bean.
280            *
281            * @param beanIdentifier the Spring bean ID for this bean
282            */
283            public void setBeanIdentifier(java.lang.String beanIdentifier);
284    
285            public com.liferay.portlet.ratings.model.RatingsEntry updateEntry(
286                    long userId, java.lang.String className, long classPK, double score,
287                    com.liferay.portal.service.ServiceContext serviceContext)
288                    throws com.liferay.portal.kernel.exception.PortalException;
289    
290            /**
291            * Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
292            *
293            * @param ratingsEntry the ratings entry
294            * @return the ratings entry that was updated
295            */
296            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
297            public com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry(
298                    com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry);
299    }