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