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 com.liferay.portal.kernel.exception.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) 101 throws com.liferay.portal.kernel.exception.PortalException; 102 103 public void deleteStats(java.lang.String className, long classPK); 104 105 public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery(); 106 107 /** 108 * Performs a dynamic query on the database and returns the matching rows. 109 * 110 * @param dynamicQuery the dynamic query 111 * @return the matching rows 112 */ 113 public <T> java.util.List<T> dynamicQuery( 114 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 115 116 /** 117 * Performs a dynamic query on the database and returns a range of the matching rows. 118 * 119 * <p> 120 * 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. 121 * </p> 122 * 123 * @param dynamicQuery the dynamic query 124 * @param start the lower bound of the range of model instances 125 * @param end the upper bound of the range of model instances (not inclusive) 126 * @return the range of matching rows 127 */ 128 public <T> java.util.List<T> dynamicQuery( 129 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 130 int end); 131 132 /** 133 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 134 * 135 * <p> 136 * 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. 137 * </p> 138 * 139 * @param dynamicQuery the dynamic query 140 * @param start the lower bound of the range of model instances 141 * @param end the upper bound of the range of model instances (not inclusive) 142 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 143 * @return the ordered range of matching rows 144 */ 145 public <T> java.util.List<T> dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator); 149 150 /** 151 * Returns the number of rows matching the dynamic query. 152 * 153 * @param dynamicQuery the dynamic query 154 * @return the number of rows matching the dynamic query 155 */ 156 public long dynamicQueryCount( 157 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery); 158 159 /** 160 * Returns the number of rows matching the dynamic query. 161 * 162 * @param dynamicQuery the dynamic query 163 * @param projection the projection to apply to the query 164 * @return the number of rows matching the dynamic query 165 */ 166 public long dynamicQueryCount( 167 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, 168 com.liferay.portal.kernel.dao.orm.Projection projection); 169 170 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 171 public com.liferay.portlet.ratings.model.RatingsStats fetchRatingsStats( 172 long statsId); 173 174 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 175 public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery(); 176 177 /** 178 * Returns the Spring bean ID for this bean. 179 * 180 * @return the Spring bean ID for this bean 181 */ 182 public java.lang.String getBeanIdentifier(); 183 184 @Override 185 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 186 public com.liferay.portal.model.PersistedModel getPersistedModel( 187 java.io.Serializable primaryKeyObj) 188 throws com.liferay.portal.kernel.exception.PortalException; 189 190 /** 191 * Returns the ratings stats with the primary key. 192 * 193 * @param statsId the primary key of the ratings stats 194 * @return the ratings stats 195 * @throws PortalException if a ratings stats with the primary key could not be found 196 */ 197 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 198 public com.liferay.portlet.ratings.model.RatingsStats getRatingsStats( 199 long statsId) 200 throws com.liferay.portal.kernel.exception.PortalException; 201 202 /** 203 * Returns a range of all the ratings statses. 204 * 205 * <p> 206 * 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. 207 * </p> 208 * 209 * @param start the lower bound of the range of ratings statses 210 * @param end the upper bound of the range of ratings statses (not inclusive) 211 * @return the range of ratings statses 212 */ 213 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 214 public java.util.List<com.liferay.portlet.ratings.model.RatingsStats> getRatingsStatses( 215 int start, int end); 216 217 /** 218 * Returns the number of ratings statses. 219 * 220 * @return the number of ratings statses 221 */ 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public int getRatingsStatsesCount(); 224 225 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 226 public com.liferay.portlet.ratings.model.RatingsStats getStats( 227 java.lang.String className, long classPK); 228 229 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 230 public java.util.List<com.liferay.portlet.ratings.model.RatingsStats> getStats( 231 java.lang.String className, java.util.List<java.lang.Long> classPKs); 232 233 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 234 public com.liferay.portlet.ratings.model.RatingsStats getStats(long statsId) 235 throws com.liferay.portal.kernel.exception.PortalException; 236 237 /** 238 * Sets the Spring bean ID for this bean. 239 * 240 * @param beanIdentifier the Spring bean ID for this bean 241 */ 242 public void setBeanIdentifier(java.lang.String beanIdentifier); 243 244 /** 245 * Updates the ratings stats in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 246 * 247 * @param ratingsStats the ratings stats 248 * @return the ratings stats that was updated 249 */ 250 @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX) 251 public com.liferay.portlet.ratings.model.RatingsStats updateRatingsStats( 252 com.liferay.portlet.ratings.model.RatingsStats ratingsStats); 253 }