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.ratings.kernel.service;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
020    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
021    import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
022    import com.liferay.portal.kernel.dao.orm.Projection;
023    import com.liferay.portal.kernel.exception.PortalException;
024    import com.liferay.portal.kernel.exception.SystemException;
025    import com.liferay.portal.kernel.model.PersistedModel;
026    import com.liferay.portal.kernel.search.Indexable;
027    import com.liferay.portal.kernel.search.IndexableType;
028    import com.liferay.portal.kernel.service.BaseLocalService;
029    import com.liferay.portal.kernel.service.PersistedModelLocalService;
030    import com.liferay.portal.kernel.transaction.Isolation;
031    import com.liferay.portal.kernel.transaction.Propagation;
032    import com.liferay.portal.kernel.transaction.Transactional;
033    import com.liferay.portal.kernel.util.OrderByComparator;
034    
035    import com.liferay.ratings.kernel.model.RatingsStats;
036    
037    import java.io.Serializable;
038    
039    import java.util.List;
040    
041    /**
042     * Provides the local service interface for RatingsStats. Methods of this
043     * service will not have security checks based on the propagated JAAS
044     * credentials because this service can only be accessed from within the same
045     * VM.
046     *
047     * @author Brian Wing Shun Chan
048     * @see RatingsStatsLocalServiceUtil
049     * @see com.liferay.portlet.ratings.service.base.RatingsStatsLocalServiceBaseImpl
050     * @see com.liferay.portlet.ratings.service.impl.RatingsStatsLocalServiceImpl
051     * @generated
052     */
053    @ProviderType
054    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
055            PortalException.class, SystemException.class})
056    public interface RatingsStatsLocalService extends BaseLocalService,
057            PersistedModelLocalService {
058            /*
059             * NOTE FOR DEVELOPERS:
060             *
061             * 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.
062             */
063            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
064            public ActionableDynamicQuery getActionableDynamicQuery();
065    
066            public DynamicQuery dynamicQuery();
067    
068            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
069            public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
070    
071            /**
072            * @throws PortalException
073            */
074            @Override
075            public PersistedModel deletePersistedModel(PersistedModel persistedModel)
076                    throws PortalException;
077    
078            @Override
079            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
080            public PersistedModel getPersistedModel(Serializable primaryKeyObj)
081                    throws PortalException;
082    
083            /**
084            * Adds the ratings stats to the database. Also notifies the appropriate model listeners.
085            *
086            * @param ratingsStats the ratings stats
087            * @return the ratings stats that was added
088            */
089            @Indexable(type = IndexableType.REINDEX)
090            public RatingsStats addRatingsStats(RatingsStats ratingsStats);
091    
092            public RatingsStats addStats(long classNameId, long classPK);
093    
094            /**
095            * Creates a new ratings stats with the primary key. Does not add the ratings stats to the database.
096            *
097            * @param statsId the primary key for the new ratings stats
098            * @return the new ratings stats
099            */
100            public RatingsStats createRatingsStats(long statsId);
101    
102            /**
103            * Deletes the ratings stats from the database. Also notifies the appropriate model listeners.
104            *
105            * @param ratingsStats the ratings stats
106            * @return the ratings stats that was removed
107            */
108            @Indexable(type = IndexableType.DELETE)
109            public RatingsStats deleteRatingsStats(RatingsStats ratingsStats);
110    
111            /**
112            * Deletes the ratings stats with the primary key from the database. Also notifies the appropriate model listeners.
113            *
114            * @param statsId the primary key of the ratings stats
115            * @return the ratings stats that was removed
116            * @throws PortalException if a ratings stats with the primary key could not be found
117            */
118            @Indexable(type = IndexableType.DELETE)
119            public RatingsStats deleteRatingsStats(long statsId)
120                    throws PortalException;
121    
122            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
123            public RatingsStats fetchRatingsStats(long statsId);
124    
125            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
126            public RatingsStats fetchStats(java.lang.String className, long classPK);
127    
128            /**
129            * Returns the ratings stats with the primary key.
130            *
131            * @param statsId the primary key of the ratings stats
132            * @return the ratings stats
133            * @throws PortalException if a ratings stats with the primary key could not be found
134            */
135            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
136            public RatingsStats getRatingsStats(long statsId) throws PortalException;
137    
138            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
139            public RatingsStats getStats(java.lang.String className, long classPK);
140    
141            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
142            public RatingsStats getStats(long statsId) throws PortalException;
143    
144            /**
145            * Updates the ratings stats in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
146            *
147            * @param ratingsStats the ratings stats
148            * @return the ratings stats that was updated
149            */
150            @Indexable(type = IndexableType.REINDEX)
151            public RatingsStats updateRatingsStats(RatingsStats ratingsStats);
152    
153            /**
154            * Returns the number of ratings statses.
155            *
156            * @return the number of ratings statses
157            */
158            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
159            public int getRatingsStatsesCount();
160    
161            /**
162            * Returns the OSGi service identifier.
163            *
164            * @return the OSGi service identifier
165            */
166            public java.lang.String getOSGiServiceIdentifier();
167    
168            /**
169            * Performs a dynamic query on the database and returns the matching rows.
170            *
171            * @param dynamicQuery the dynamic query
172            * @return the matching rows
173            */
174            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery);
175    
176            /**
177            * Performs a dynamic query on the database and returns a range of the matching rows.
178            *
179            * <p>
180            * 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.
181            * </p>
182            *
183            * @param dynamicQuery the dynamic query
184            * @param start the lower bound of the range of model instances
185            * @param end the upper bound of the range of model instances (not inclusive)
186            * @return the range of matching rows
187            */
188            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
189                    int end);
190    
191            /**
192            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
193            *
194            * <p>
195            * 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.
196            * </p>
197            *
198            * @param dynamicQuery the dynamic query
199            * @param start the lower bound of the range of model instances
200            * @param end the upper bound of the range of model instances (not inclusive)
201            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
202            * @return the ordered range of matching rows
203            */
204            public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start,
205                    int end, OrderByComparator<T> orderByComparator);
206    
207            /**
208            * Returns a range of all the ratings statses.
209            *
210            * <p>
211            * 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.
212            * </p>
213            *
214            * @param start the lower bound of the range of ratings statses
215            * @param end the upper bound of the range of ratings statses (not inclusive)
216            * @return the range of ratings statses
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public List<RatingsStats> getRatingsStatses(int start, int end);
220    
221            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
222            public List<RatingsStats> getStats(java.lang.String className,
223                    List<java.lang.Long> classPKs);
224    
225            /**
226            * Returns the number of rows matching the dynamic query.
227            *
228            * @param dynamicQuery the dynamic query
229            * @return the number of rows matching the dynamic query
230            */
231            public long dynamicQueryCount(DynamicQuery dynamicQuery);
232    
233            /**
234            * Returns the number of rows matching the dynamic query.
235            *
236            * @param dynamicQuery the dynamic query
237            * @param projection the projection to apply to the query
238            * @return the number of rows matching the dynamic query
239            */
240            public long dynamicQueryCount(DynamicQuery dynamicQuery,
241                    Projection projection);
242    
243            public void deleteStats(java.lang.String className, long classPK);
244    }