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