001 /** 002 * Copyright (c) 2000-2011 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.social.service; 016 017 import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil; 018 import com.liferay.portal.kernel.util.MethodCache; 019 import com.liferay.portal.kernel.util.ReferenceRegistry; 020 021 /** 022 * The utility for the social equity user local service. This utility wraps {@link com.liferay.portlet.social.service.impl.SocialEquityUserLocalServiceImpl} and is the primary access point for service operations in application layer code running on the local server. 023 * 024 * <p> 025 * 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. 026 * </p> 027 * 028 * @author Brian Wing Shun Chan 029 * @see SocialEquityUserLocalService 030 * @see com.liferay.portlet.social.service.base.SocialEquityUserLocalServiceBaseImpl 031 * @see com.liferay.portlet.social.service.impl.SocialEquityUserLocalServiceImpl 032 * @generated 033 */ 034 public class SocialEquityUserLocalServiceUtil { 035 /* 036 * NOTE FOR DEVELOPERS: 037 * 038 * Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialEquityUserLocalServiceImpl} and rerun ServiceBuilder to regenerate this class. 039 */ 040 041 /** 042 * Adds the social equity user to the database. Also notifies the appropriate model listeners. 043 * 044 * @param socialEquityUser the social equity user 045 * @return the social equity user that was added 046 * @throws SystemException if a system exception occurred 047 */ 048 public static com.liferay.portlet.social.model.SocialEquityUser addSocialEquityUser( 049 com.liferay.portlet.social.model.SocialEquityUser socialEquityUser) 050 throws com.liferay.portal.kernel.exception.SystemException { 051 return getService().addSocialEquityUser(socialEquityUser); 052 } 053 054 /** 055 * Creates a new social equity user with the primary key. Does not add the social equity user to the database. 056 * 057 * @param equityUserId the primary key for the new social equity user 058 * @return the new social equity user 059 */ 060 public static com.liferay.portlet.social.model.SocialEquityUser createSocialEquityUser( 061 long equityUserId) { 062 return getService().createSocialEquityUser(equityUserId); 063 } 064 065 /** 066 * Deletes the social equity user with the primary key from the database. Also notifies the appropriate model listeners. 067 * 068 * @param equityUserId the primary key of the social equity user 069 * @throws PortalException if a social equity user with the primary key could not be found 070 * @throws SystemException if a system exception occurred 071 */ 072 public static void deleteSocialEquityUser(long equityUserId) 073 throws com.liferay.portal.kernel.exception.PortalException, 074 com.liferay.portal.kernel.exception.SystemException { 075 getService().deleteSocialEquityUser(equityUserId); 076 } 077 078 /** 079 * Deletes the social equity user from the database. Also notifies the appropriate model listeners. 080 * 081 * @param socialEquityUser the social equity user 082 * @throws SystemException if a system exception occurred 083 */ 084 public static void deleteSocialEquityUser( 085 com.liferay.portlet.social.model.SocialEquityUser socialEquityUser) 086 throws com.liferay.portal.kernel.exception.SystemException { 087 getService().deleteSocialEquityUser(socialEquityUser); 088 } 089 090 /** 091 * Performs a dynamic query on the database and returns the matching rows. 092 * 093 * @param dynamicQuery the dynamic query 094 * @return the matching rows 095 * @throws SystemException if a system exception occurred 096 */ 097 @SuppressWarnings("rawtypes") 098 public static java.util.List dynamicQuery( 099 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 100 throws com.liferay.portal.kernel.exception.SystemException { 101 return getService().dynamicQuery(dynamicQuery); 102 } 103 104 /** 105 * Performs a dynamic query on the database and returns a range of the matching rows. 106 * 107 * <p> 108 * 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. 109 * </p> 110 * 111 * @param dynamicQuery the dynamic query 112 * @param start the lower bound of the range of model instances 113 * @param end the upper bound of the range of model instances (not inclusive) 114 * @return the range of matching rows 115 * @throws SystemException if a system exception occurred 116 */ 117 @SuppressWarnings("rawtypes") 118 public static java.util.List dynamicQuery( 119 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, 120 int end) throws com.liferay.portal.kernel.exception.SystemException { 121 return getService().dynamicQuery(dynamicQuery, start, end); 122 } 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. 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 static 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 return getService() 145 .dynamicQuery(dynamicQuery, start, end, orderByComparator); 146 } 147 148 /** 149 * Returns the number of rows that match the dynamic query. 150 * 151 * @param dynamicQuery the dynamic query 152 * @return the number of rows that match the dynamic query 153 * @throws SystemException if a system exception occurred 154 */ 155 public static long dynamicQueryCount( 156 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) 157 throws com.liferay.portal.kernel.exception.SystemException { 158 return getService().dynamicQueryCount(dynamicQuery); 159 } 160 161 /** 162 * Returns the social equity user with the primary key. 163 * 164 * @param equityUserId the primary key of the social equity user 165 * @return the social equity user 166 * @throws PortalException if a social equity user with the primary key could not be found 167 * @throws SystemException if a system exception occurred 168 */ 169 public static com.liferay.portlet.social.model.SocialEquityUser getSocialEquityUser( 170 long equityUserId) 171 throws com.liferay.portal.kernel.exception.PortalException, 172 com.liferay.portal.kernel.exception.SystemException { 173 return getService().getSocialEquityUser(equityUserId); 174 } 175 176 public static 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 return getService().getPersistedModel(primaryKeyObj); 181 } 182 183 /** 184 * Returns a range of all the social equity users. 185 * 186 * <p> 187 * 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. 188 * </p> 189 * 190 * @param start the lower bound of the range of social equity users 191 * @param end the upper bound of the range of social equity users (not inclusive) 192 * @return the range of social equity users 193 * @throws SystemException if a system exception occurred 194 */ 195 public static java.util.List<com.liferay.portlet.social.model.SocialEquityUser> getSocialEquityUsers( 196 int start, int end) 197 throws com.liferay.portal.kernel.exception.SystemException { 198 return getService().getSocialEquityUsers(start, end); 199 } 200 201 /** 202 * Returns the number of social equity users. 203 * 204 * @return the number of social equity users 205 * @throws SystemException if a system exception occurred 206 */ 207 public static int getSocialEquityUsersCount() 208 throws com.liferay.portal.kernel.exception.SystemException { 209 return getService().getSocialEquityUsersCount(); 210 } 211 212 /** 213 * Updates the social equity user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 214 * 215 * @param socialEquityUser the social equity user 216 * @return the social equity user that was updated 217 * @throws SystemException if a system exception occurred 218 */ 219 public static com.liferay.portlet.social.model.SocialEquityUser updateSocialEquityUser( 220 com.liferay.portlet.social.model.SocialEquityUser socialEquityUser) 221 throws com.liferay.portal.kernel.exception.SystemException { 222 return getService().updateSocialEquityUser(socialEquityUser); 223 } 224 225 /** 226 * Updates the social equity user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners. 227 * 228 * @param socialEquityUser the social equity user 229 * @param merge whether to merge the social equity user 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. 230 * @return the social equity user that was updated 231 * @throws SystemException if a system exception occurred 232 */ 233 public static com.liferay.portlet.social.model.SocialEquityUser updateSocialEquityUser( 234 com.liferay.portlet.social.model.SocialEquityUser socialEquityUser, 235 boolean merge) 236 throws com.liferay.portal.kernel.exception.SystemException { 237 return getService().updateSocialEquityUser(socialEquityUser, merge); 238 } 239 240 /** 241 * Returns the Spring bean ID for this bean. 242 * 243 * @return the Spring bean ID for this bean 244 */ 245 public static java.lang.String getBeanIdentifier() { 246 return getService().getBeanIdentifier(); 247 } 248 249 /** 250 * Sets the Spring bean ID for this bean. 251 * 252 * @param beanIdentifier the Spring bean ID for this bean 253 */ 254 public static void setBeanIdentifier(java.lang.String beanIdentifier) { 255 getService().setBeanIdentifier(beanIdentifier); 256 } 257 258 /** 259 * Removes ranking for the user with respect to all groups. 260 * 261 * <p> 262 * This method is called by the portal when a user is deactivated. 263 * </p> 264 * 265 * @param userId the primary key of the user 266 * @throws SystemException if a system exception occurred 267 */ 268 public static void clearRanks(long userId) 269 throws com.liferay.portal.kernel.exception.SystemException { 270 getService().clearRanks(userId); 271 } 272 273 /** 274 * Returns the contribution equity score for the user. 275 * 276 * <p> 277 * This method should only be used if social equity is turned on for only 278 * one group, as it returns the contribution score for the first group it 279 * finds. The first group found can be different from one execution to the 280 * next. 281 * </p> 282 * 283 * @param userId the primary key of the user 284 * @return the contribution equity score 285 * @throws SystemException if a system exception occurred 286 */ 287 public static com.liferay.portlet.social.model.SocialEquityValue getContributionEquity( 288 long userId) throws com.liferay.portal.kernel.exception.SystemException { 289 return getService().getContributionEquity(userId); 290 } 291 292 /** 293 * Returns the contribution equity score of the user with respect to the 294 * group. 295 * 296 * @param userId the primary key of the user 297 * @param groupId the primary key of the group 298 * @return the contribution equity score 299 * @throws SystemException if a system exception occurred 300 */ 301 public static com.liferay.portlet.social.model.SocialEquityValue getContributionEquity( 302 long userId, long groupId) 303 throws com.liferay.portal.kernel.exception.SystemException { 304 return getService().getContributionEquity(userId, groupId); 305 } 306 307 /** 308 * Returns the participation equity score for the user. 309 * 310 * <p> 311 * This method should only be used if social equity is turned on for only 312 * one group, as it returns the participation score for the first group it 313 * finds. The first group found can be different from one execution to the 314 * next. 315 * </p> 316 * 317 * @param userId the primary key of the user 318 * @return the participation equity score 319 * @throws SystemException if a system exception occurred 320 */ 321 public static com.liferay.portlet.social.model.SocialEquityValue getParticipationEquity( 322 long userId) throws com.liferay.portal.kernel.exception.SystemException { 323 return getService().getParticipationEquity(userId); 324 } 325 326 /** 327 * Returns the participation equity score of the user with respect to the 328 * group. 329 * 330 * @param userId the primary key of the user 331 * @param groupId the primary key of the group 332 * @return the participation equity score 333 * @throws SystemException if a system exception occurred 334 */ 335 public static com.liferay.portlet.social.model.SocialEquityValue getParticipationEquity( 336 long userId, long groupId) 337 throws com.liferay.portal.kernel.exception.SystemException { 338 return getService().getParticipationEquity(userId, groupId); 339 } 340 341 /** 342 * Returns the rank of the user in the group based on the user's personal 343 * equity. 344 * 345 * @param groupId the primary key of the group 346 * @param userId the primary key of the user 347 * @return the rank for the user in the group 348 * @throws SystemException if a system exception occurred 349 */ 350 public static int getRank(long groupId, long userId) 351 throws com.liferay.portal.kernel.exception.SystemException { 352 return getService().getRank(groupId, userId); 353 } 354 355 /** 356 * Returns an ordered range of all the social equity users in the group 357 * with rankings greater than zero. It is strongly suggested to use {@link 358 * com.liferay.portlet.social.util.comparator.SocialEquityUserRankComparator} 359 * as the ordering comparator. 360 * 361 * <p> 362 * Useful when paginating results. Returns a maximum of <code>end - 363 * start</code> instances. <code>start</code> and <code>end</code> are not 364 * primary keys, they are indexes in the result set. Thus, <code>0</code> 365 * refers to the first result in the set. Setting both <code>start</code> 366 * and <code>end</code> to {@link 367 * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the 368 * full result set. 369 * </p> 370 * 371 * @param groupId the primary key of the group 372 * @param start the lower bound of the range of results 373 * @param end the upper bound of the range of results (not inclusive) 374 * @param orderByComparator the comparator to order the social equity 375 users, such as {@link 376 com.liferay.portlet.social.util.comparator.SocialEquityUserRankComparator} 377 (optionally <code>null</code>) 378 * @return the ordered range of the social equity users 379 * @throws SystemException if a system exception occurred 380 */ 381 public static java.util.List<com.liferay.portlet.social.model.SocialEquityUser> getRankedEquityUsers( 382 long groupId, int start, int end, 383 com.liferay.portal.kernel.util.OrderByComparator orderByComparator) 384 throws com.liferay.portal.kernel.exception.SystemException { 385 return getService() 386 .getRankedEquityUsers(groupId, start, end, orderByComparator); 387 } 388 389 /** 390 * Returns the number of the social equity users in the group with rankings 391 * greater than zero. 392 * 393 * @param groupId the primary key of the group 394 * @return the number of social equity users with rankings greater than 395 zero 396 * @throws SystemException if a system exception occurred 397 */ 398 public static int getRankedEquityUsersCount(long groupId) 399 throws com.liferay.portal.kernel.exception.SystemException { 400 return getService().getRankedEquityUsersCount(groupId); 401 } 402 403 public static SocialEquityUserLocalService getService() { 404 if (_service == null) { 405 _service = (SocialEquityUserLocalService)PortalBeanLocatorUtil.locate(SocialEquityUserLocalService.class.getName()); 406 407 ReferenceRegistry.registerReference(SocialEquityUserLocalServiceUtil.class, 408 "_service"); 409 MethodCache.remove(SocialEquityUserLocalService.class); 410 } 411 412 return _service; 413 } 414 415 public void setService(SocialEquityUserLocalService service) { 416 MethodCache.remove(SocialEquityUserLocalService.class); 417 418 _service = service; 419 420 ReferenceRegistry.registerReference(SocialEquityUserLocalServiceUtil.class, 421 "_service"); 422 MethodCache.remove(SocialEquityUserLocalService.class); 423 } 424 425 private static SocialEquityUserLocalService _service; 426 }