001 /** 002 * Copyright (c) 2000-2010 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.annotation.Isolation; 018 import com.liferay.portal.kernel.annotation.Propagation; 019 import com.liferay.portal.kernel.annotation.Transactional; 020 import com.liferay.portal.kernel.exception.PortalException; 021 import com.liferay.portal.kernel.exception.SystemException; 022 023 /** 024 * The interface for the ratings entry local service. 025 * 026 * <p> 027 * 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. 028 * </p> 029 * 030 * <p> 031 * 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. 032 * </p> 033 * 034 * @author Brian Wing Shun Chan 035 * @see RatingsEntryLocalServiceUtil 036 * @see com.liferay.portlet.ratings.service.base.RatingsEntryLocalServiceBaseImpl 037 * @see com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl 038 * @generated 039 */ 040 @Transactional(isolation = Isolation.PORTAL, rollbackFor = { 041 PortalException.class, SystemException.class}) 042 public interface RatingsEntryLocalService { 043 /** 044 * Adds the ratings entry to the database. Also notifies the appropriate model listeners. 045 * 046 * @param ratingsEntry the ratings entry to add 047 * @return the ratings entry that was added 048 * @throws SystemException if a system exception occurred 049 */ 050 public com.liferay.portlet.ratings.model.RatingsEntry addRatingsEntry( 051 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry) 052 throws com.liferay.portal.kernel.exception.SystemException; 053 054 /** 055 * Creates a new ratings entry with the primary key. Does not add the ratings entry to the database. 056 * 057 * @param entryId the primary key for the new ratings entry 058 * @return the new ratings entry 059 */ 060 public com.liferay.portlet.ratings.model.RatingsEntry createRatingsEntry( 061 long entryId); 062 063 /** 064 * Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners. 065 * 066 * @param entryId the primary key of the ratings entry to delete 067 * @throws PortalException if a ratings entry with the primary key could not be found 068 * @throws SystemException if a system exception occurred 069 */ 070 public void deleteRatingsEntry(long entryId) 071 throws com.liferay.portal.kernel.exception.PortalException, 072 com.liferay.portal.kernel.exception.SystemException; 073 074 /** 075 * Deletes the ratings entry from the database. Also notifies the appropriate model listeners. 076 * 077 * @param ratingsEntry the ratings entry to delete 078 * @throws SystemException if a system exception occurred 079 */ 080 public void deleteRatingsEntry( 081 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry) 082 throws com.liferay.portal.kernel.exception.SystemException; 083 084 /** 085 * Performs a dynamic query on the database and returns the matching rows. 086 * 087 * @param dynamicQuery the dynamic query to search with 088 * @return the matching rows 089 * @throws SystemException if a system exception occurred 090 */ 091 @SuppressWarnings("rawtypes") 092 public java.util.List dynamicQuery( 093 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 094 throws com.liferay.portal.kernel.exception.SystemException; 095 096 /** 097 * Performs a dynamic query on the database and returns a range of the matching rows. 098 * 099 * <p> 100 * 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. 101 * </p> 102 * 103 * @param dynamicQuery the dynamic query to search with 104 * @param start the lower bound of the range of model instances to return 105 * @param end the upper bound of the range of model instances to return (not inclusive) 106 * @return the range of matching rows 107 * @throws SystemException if a system exception occurred 108 */ 109 @SuppressWarnings("rawtypes") 110 public java.util.List dynamicQuery( 111 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 112 int end) throws com.liferay.portal.kernel.exception.SystemException; 113 114 /** 115 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 116 * 117 * <p> 118 * 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. 119 * </p> 120 * 121 * @param dynamicQuery the dynamic query to search with 122 * @param start the lower bound of the range of model instances to return 123 * @param end the upper bound of the range of model instances to return (not inclusive) 124 * @param orderByComparator the comparator to order the results by 125 * @return the ordered range of matching rows 126 * @throws SystemException if a system exception occurred 127 */ 128 @SuppressWarnings("rawtypes") 129 public java.util.List dynamicQuery( 130 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 131 int end, 132 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 133 throws com.liferay.portal.kernel.exception.SystemException; 134 135 /** 136 * Counts the number of rows that match the dynamic query. 137 * 138 * @param dynamicQuery the dynamic query to search with 139 * @return the number of rows that match the dynamic query 140 * @throws SystemException if a system exception occurred 141 */ 142 public long dynamicQueryCount( 143 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 144 throws com.liferay.portal.kernel.exception.SystemException; 145 146 /** 147 * Gets the ratings entry with the primary key. 148 * 149 * @param entryId the primary key of the ratings entry to get 150 * @return the ratings entry 151 * @throws PortalException if a ratings entry with the primary key could not be found 152 * @throws SystemException if a system exception occurred 153 */ 154 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 155 public com.liferay.portlet.ratings.model.RatingsEntry getRatingsEntry( 156 long entryId) 157 throws com.liferay.portal.kernel.exception.PortalException, 158 com.liferay.portal.kernel.exception.SystemException; 159 160 /** 161 * Gets a range of all the ratings entries. 162 * 163 * <p> 164 * 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. 165 * </p> 166 * 167 * @param start the lower bound of the range of ratings entries to return 168 * @param end the upper bound of the range of ratings entries to return (not inclusive) 169 * @return the range of ratings entries 170 * @throws SystemException if a system exception occurred 171 */ 172 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 173 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getRatingsEntries( 174 int start, int end) 175 throws com.liferay.portal.kernel.exception.SystemException; 176 177 /** 178 * Gets the number of ratings entries. 179 * 180 * @return the number of ratings entries 181 * @throws SystemException if a system exception occurred 182 */ 183 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 184 public int getRatingsEntriesCount() 185 throws com.liferay.portal.kernel.exception.SystemException; 186 187 /** 188 * Updates the ratings entry in the database. Also notifies the appropriate model listeners. 189 * 190 * @param ratingsEntry the ratings entry to update 191 * @return the ratings entry that was updated 192 * @throws SystemException if a system exception occurred 193 */ 194 public com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry( 195 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry) 196 throws com.liferay.portal.kernel.exception.SystemException; 197 198 /** 199 * Updates the ratings entry in the database. Also notifies the appropriate model listeners. 200 * 201 * @param ratingsEntry the ratings entry to update 202 * @param merge whether to merge the ratings entry with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation. 203 * @return the ratings entry that was updated 204 * @throws SystemException if a system exception occurred 205 */ 206 public com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry( 207 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry, 208 boolean merge) 209 throws com.liferay.portal.kernel.exception.SystemException; 210 211 public void deleteEntry(long userId, java.lang.String className, 212 long classPK) 213 throws com.liferay.portal.kernel.exception.PortalException, 214 com.liferay.portal.kernel.exception.SystemException; 215 216 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 217 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries( 218 long userId, java.lang.String className, 219 java.util.List<java.lang.Long> classPKs) 220 throws com.liferay.portal.kernel.exception.SystemException; 221 222 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 223 public java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries( 224 java.lang.String className, long classPK) 225 throws com.liferay.portal.kernel.exception.SystemException; 226 227 @Transactional(propagation = Propagation.SUPPORTS, readOnly = true) 228 public com.liferay.portlet.ratings.model.RatingsEntry getEntry( 229 long userId, java.lang.String className, long classPK) 230 throws com.liferay.portal.kernel.exception.PortalException, 231 com.liferay.portal.kernel.exception.SystemException; 232 233 public com.liferay.portlet.ratings.model.RatingsEntry updateEntry( 234 long userId, java.lang.String className, long classPK, double score, 235 com.liferay.portal.service.ServiceContext serviceContext) 236 throws com.liferay.portal.kernel.exception.PortalException, 237 com.liferay.portal.kernel.exception.SystemException; 238 }