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