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