001 /** 002 * Copyright (c) 2000-2012 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.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.ReferenceRegistry; 019 020 /** 021 * The utility for the ratings entry local service. This utility wraps {@link com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 022 * 023 * <p> 024 * 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. 025 * </p> 026 * 027 * @author Brian Wing Shun Chan 028 * @see RatingsEntryLocalService 029 * @see com.liferay.portlet.ratings.service.base.RatingsEntryLocalServiceBaseImpl 030 * @see com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl 031 * @generated 032 */ 033 public class RatingsEntryLocalServiceUtil { 034 /* 035 * NOTE FOR DEVELOPERS: 036 * 037 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.ratings.service.impl.RatingsEntryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 038 */ 039 040 /** 041 * Adds the ratings entry to the database. Also notifies the appropriate model listeners. 042 * 043 * @param ratingsEntry the ratings entry 044 * @return the ratings entry that was added 045 * @throws SystemException if a system exception occurred 046 */ 047 public static com.liferay.portlet.ratings.model.RatingsEntry addRatingsEntry( 048 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry) 049 throws com.liferay.portal.kernel.exception.SystemException { 050 return getService().addRatingsEntry(ratingsEntry); 051 } 052 053 /** 054 * Creates a new ratings entry with the primary key. Does not add the ratings entry to the database. 055 * 056 * @param entryId the primary key for the new ratings entry 057 * @return the new ratings entry 058 */ 059 public static com.liferay.portlet.ratings.model.RatingsEntry createRatingsEntry( 060 long entryId) { 061 return getService().createRatingsEntry(entryId); 062 } 063 064 /** 065 * Deletes the ratings entry with the primary key from the database. Also notifies the appropriate model listeners. 066 * 067 * @param entryId the primary key of the ratings entry 068 * @return the ratings entry that was removed 069 * @throws PortalException if a ratings entry with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static com.liferay.portlet.ratings.model.RatingsEntry deleteRatingsEntry( 073 long entryId) 074 throws com.liferay.portal.kernel.exception.PortalException, 075 com.liferay.portal.kernel.exception.SystemException { 076 return getService().deleteRatingsEntry(entryId); 077 } 078 079 /** 080 * Deletes the ratings entry from the database. Also notifies the appropriate model listeners. 081 * 082 * @param ratingsEntry the ratings entry 083 * @return the ratings entry that was removed 084 * @throws SystemException if a system exception occurred 085 */ 086 public static com.liferay.portlet.ratings.model.RatingsEntry deleteRatingsEntry( 087 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry) 088 throws com.liferay.portal.kernel.exception.SystemException { 089 return getService().deleteRatingsEntry(ratingsEntry); 090 } 091 092 public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() { 093 return getService().dynamicQuery(); 094 } 095 096 /** 097 * Performs a dynamic query on the database and returns the matching rows. 098 * 099 * @param dynamicQuery the dynamic query 100 * @return the matching rows 101 * @throws SystemException if a system exception occurred 102 */ 103 @SuppressWarnings("rawtypes") 104 public static java.util.List dynamicQuery( 105 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 106 throws com.liferay.portal.kernel.exception.SystemException { 107 return getService().dynamicQuery(dynamicQuery); 108 } 109 110 /** 111 * Performs a dynamic query on the database and returns a range of the matching rows. 112 * 113 * <p> 114 * 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. 115 * </p> 116 * 117 * @param dynamicQuery the dynamic query 118 * @param start the lower bound of the range of model instances 119 * @param end the upper bound of the range of model instances (not inclusive) 120 * @return the range of matching rows 121 * @throws SystemException if a system exception occurred 122 */ 123 @SuppressWarnings("rawtypes") 124 public static java.util.List dynamicQuery( 125 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 126 int end) throws com.liferay.portal.kernel.exception.SystemException { 127 return getService().dynamicQuery(dynamicQuery, start, end); 128 } 129 130 /** 131 * Performs a dynamic query on the database and returns an ordered range of the matching rows. 132 * 133 * <p> 134 * 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. 135 * </p> 136 * 137 * @param dynamicQuery the dynamic query 138 * @param start the lower bound of the range of model instances 139 * @param end the upper bound of the range of model instances (not inclusive) 140 * @param orderByComparator the comparator to order the results by (optionally <code>null</code>) 141 * @return the ordered range of matching rows 142 * @throws SystemException if a system exception occurred 143 */ 144 @SuppressWarnings("rawtypes") 145 public static java.util.List dynamicQuery( 146 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 147 int end, 148 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 149 throws com.liferay.portal.kernel.exception.SystemException { 150 return getService() 151 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 152 } 153 154 /** 155 * Returns the number of rows that match the dynamic query. 156 * 157 * @param dynamicQuery the dynamic query 158 * @return the number of rows that match the dynamic query 159 * @throws SystemException if a system exception occurred 160 */ 161 public static long dynamicQueryCount( 162 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 163 throws com.liferay.portal.kernel.exception.SystemException { 164 return getService().dynamicQueryCount(dynamicQuery); 165 } 166 167 public static com.liferay.portlet.ratings.model.RatingsEntry fetchRatingsEntry( 168 long entryId) 169 throws com.liferay.portal.kernel.exception.SystemException { 170 return getService().fetchRatingsEntry(entryId); 171 } 172 173 /** 174 * Returns the ratings entry with the primary key. 175 * 176 * @param entryId the primary key of the ratings entry 177 * @return the ratings entry 178 * @throws PortalException if a ratings entry with the primary key could not be found 179 * @throws SystemException if a system exception occurred 180 */ 181 public static com.liferay.portlet.ratings.model.RatingsEntry getRatingsEntry( 182 long entryId) 183 throws com.liferay.portal.kernel.exception.PortalException, 184 com.liferay.portal.kernel.exception.SystemException { 185 return getService().getRatingsEntry(entryId); 186 } 187 188 public static com.liferay.portal.model.PersistedModel getPersistedModel( 189 java.io.Serializable primaryKeyObj) 190 throws com.liferay.portal.kernel.exception.PortalException, 191 com.liferay.portal.kernel.exception.SystemException { 192 return getService().getPersistedModel(primaryKeyObj); 193 } 194 195 /** 196 * Returns a range of all the ratings entries. 197 * 198 * <p> 199 * 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. 200 * </p> 201 * 202 * @param start the lower bound of the range of ratings entries 203 * @param end the upper bound of the range of ratings entries (not inclusive) 204 * @return the range of ratings entries 205 * @throws SystemException if a system exception occurred 206 */ 207 public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getRatingsEntries( 208 int start, int end) 209 throws com.liferay.portal.kernel.exception.SystemException { 210 return getService().getRatingsEntries(start, end); 211 } 212 213 /** 214 * Returns the number of ratings entries. 215 * 216 * @return the number of ratings entries 217 * @throws SystemException if a system exception occurred 218 */ 219 public static int getRatingsEntriesCount() 220 throws com.liferay.portal.kernel.exception.SystemException { 221 return getService().getRatingsEntriesCount(); 222 } 223 224 /** 225 * Updates the ratings entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 226 * 227 * @param ratingsEntry the ratings entry 228 * @return the ratings entry that was updated 229 * @throws SystemException if a system exception occurred 230 */ 231 public static com.liferay.portlet.ratings.model.RatingsEntry updateRatingsEntry( 232 com.liferay.portlet.ratings.model.RatingsEntry ratingsEntry) 233 throws com.liferay.portal.kernel.exception.SystemException { 234 return getService().updateRatingsEntry(ratingsEntry); 235 } 236 237 /** 238 * Returns the Spring bean ID for this bean. 239 * 240 * @return the Spring bean ID for this bean 241 */ 242 public static java.lang.String getBeanIdentifier() { 243 return getService().getBeanIdentifier(); 244 } 245 246 /** 247 * Sets the Spring bean ID for this bean. 248 * 249 * @param beanIdentifier the Spring bean ID for this bean 250 */ 251 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 252 getService().setBeanIdentifier(beanIdentifier); 253 } 254 255 public static void deleteEntry(long userId, java.lang.String className, 256 long classPK) 257 throws com.liferay.portal.kernel.exception.PortalException, 258 com.liferay.portal.kernel.exception.SystemException { 259 getService().deleteEntry(userId, className, classPK); 260 } 261 262 public static com.liferay.portlet.ratings.model.RatingsEntry fetchEntry( 263 long userId, java.lang.String className, long classPK) 264 throws com.liferay.portal.kernel.exception.SystemException { 265 return getService().fetchEntry(userId, className, classPK); 266 } 267 268 public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries( 269 long userId, java.lang.String className, 270 java.util.List<java.lang.Long> classPKs) 271 throws com.liferay.portal.kernel.exception.SystemException { 272 return getService().getEntries(userId, className, classPKs); 273 } 274 275 public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries( 276 java.lang.String className, long classPK) 277 throws com.liferay.portal.kernel.exception.SystemException { 278 return getService().getEntries(className, classPK); 279 } 280 281 public static java.util.List<com.liferay.portlet.ratings.model.RatingsEntry> getEntries( 282 java.lang.String className, long classPK, double score) 283 throws com.liferay.portal.kernel.exception.SystemException { 284 return getService().getEntries(className, classPK, score); 285 } 286 287 public static int getEntriesCount(java.lang.String className, long classPK, 288 double score) 289 throws com.liferay.portal.kernel.exception.SystemException { 290 return getService().getEntriesCount(className, classPK, score); 291 } 292 293 public static com.liferay.portlet.ratings.model.RatingsEntry getEntry( 294 long userId, java.lang.String className, long classPK) 295 throws com.liferay.portal.kernel.exception.PortalException, 296 com.liferay.portal.kernel.exception.SystemException { 297 return getService().getEntry(userId, className, classPK); 298 } 299 300 public static com.liferay.portlet.ratings.model.RatingsEntry updateEntry( 301 long userId, java.lang.String className, long classPK, double score, 302 com.liferay.portal.service.ServiceContext serviceContext) 303 throws com.liferay.portal.kernel.exception.PortalException, 304 com.liferay.portal.kernel.exception.SystemException { 305 return getService() 306 .updateEntry(userId, className, classPK, score, 307 serviceContext); 308 } 309 310 public static RatingsEntryLocalService getService() { 311 if (_service == null) { 312 _service = (RatingsEntryLocalService)PortalBeanLocatorUtil.locate(RatingsEntryLocalService.class.getName()); 313 314 ReferenceRegistry.registerReference(RatingsEntryLocalServiceUtil.class, 315 "_service"); 316 } 317 318 return _service; 319 } 320 321 /** 322 * @deprecated 323 */ 324 public void setService(RatingsEntryLocalService service) { 325 } 326 327 private static RatingsEntryLocalService _service; 328 }