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 RatingsStats. 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 RatingsStatsLocalServiceUtil
036     * @see com.liferay.portlet.ratings.service.base.RatingsStatsLocalServiceBaseImpl
037     * @see com.liferay.portlet.ratings.service.impl.RatingsStatsLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface RatingsStatsLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link RatingsStatsLocalServiceUtil} to access the ratings stats local service. Add custom service methods to {@link com.liferay.portlet.ratings.service.impl.RatingsStatsLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050    
051            /**
052            * Adds the ratings stats to the database. Also notifies the appropriate model listeners.
053            *
054            * @param ratingsStats the ratings stats
055            * @return the ratings stats that was added
056            */
057            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
058            public com.liferay.portlet.ratings.model.RatingsStats addRatingsStats(
059                    com.liferay.portlet.ratings.model.RatingsStats ratingsStats);
060    
061            public com.liferay.portlet.ratings.model.RatingsStats addStats(
062                    long classNameId, long classPK);
063    
064            /**
065            * Creates a new ratings stats with the primary key. Does not add the ratings stats to the database.
066            *
067            * @param statsId the primary key for the new ratings stats
068            * @return the new ratings stats
069            */
070            public com.liferay.portlet.ratings.model.RatingsStats createRatingsStats(
071                    long statsId);
072    
073            /**
074            * @throws PortalException
075            */
076            @Override
077            public com.liferay.portal.model.PersistedModel deletePersistedModel(
078                    com.liferay.portal.model.PersistedModel persistedModel)
079                    throws PortalException;
080    
081            /**
082            * Deletes the ratings stats from the database. Also notifies the appropriate model listeners.
083            *
084            * @param ratingsStats the ratings stats
085            * @return the ratings stats that was removed
086            */
087            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
088            public com.liferay.portlet.ratings.model.RatingsStats deleteRatingsStats(
089                    com.liferay.portlet.ratings.model.RatingsStats ratingsStats);
090    
091            /**
092            * Deletes the ratings stats with the primary key from the database. Also notifies the appropriate model listeners.
093            *
094            * @param statsId the primary key of the ratings stats
095            * @return the ratings stats that was removed
096            * @throws PortalException if a ratings stats with the primary key could not be found
097            */
098            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
099            public com.liferay.portlet.ratings.model.RatingsStats deleteRatingsStats(
100                    long statsId) throws PortalException;
101    
102            public void deleteStats(java.lang.String className, long classPK);
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.RatingsStatsModelImpl}. 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.RatingsStatsModelImpl}. 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.RatingsStats fetchRatingsStats(
171                    long statsId);
172    
173            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
174            public com.liferay.portlet.ratings.model.RatingsStats fetchStats(
175                    java.lang.String className, long classPK);
176    
177            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
178            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
179    
180            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
181            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
182    
183            /**
184            * Returns the OSGi service identifier.
185            *
186            * @return the OSGi service identifier
187            */
188            public java.lang.String getOSGiServiceIdentifier();
189    
190            @Override
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public com.liferay.portal.model.PersistedModel getPersistedModel(
193                    java.io.Serializable primaryKeyObj) throws PortalException;
194    
195            /**
196            * Returns the ratings stats with the primary key.
197            *
198            * @param statsId the primary key of the ratings stats
199            * @return the ratings stats
200            * @throws PortalException if a ratings stats with the primary key could not be found
201            */
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public com.liferay.portlet.ratings.model.RatingsStats getRatingsStats(
204                    long statsId) throws PortalException;
205    
206            /**
207            * Returns a range of all the ratings statses.
208            *
209            * <p>
210            * 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.RatingsStatsModelImpl}. 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.
211            * </p>
212            *
213            * @param start the lower bound of the range of ratings statses
214            * @param end the upper bound of the range of ratings statses (not inclusive)
215            * @return the range of ratings statses
216            */
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public java.util.List<com.liferay.portlet.ratings.model.RatingsStats> getRatingsStatses(
219                    int start, int end);
220    
221            /**
222            * Returns the number of ratings statses.
223            *
224            * @return the number of ratings statses
225            */
226            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
227            public int getRatingsStatsesCount();
228    
229            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
230            public com.liferay.portlet.ratings.model.RatingsStats getStats(
231                    java.lang.String className, long classPK);
232    
233            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
234            public java.util.List<com.liferay.portlet.ratings.model.RatingsStats> getStats(
235                    java.lang.String className, java.util.List<java.lang.Long> classPKs);
236    
237            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
238            public com.liferay.portlet.ratings.model.RatingsStats getStats(long statsId)
239                    throws PortalException;
240    
241            /**
242            * Updates the ratings stats in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
243            *
244            * @param ratingsStats the ratings stats
245            * @return the ratings stats that was updated
246            */
247            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
248            public com.liferay.portlet.ratings.model.RatingsStats updateRatingsStats(
249                    com.liferay.portlet.ratings.model.RatingsStats ratingsStats);
250    }