Liferay 6.1.0

com.liferay.portlet.social.service
Interface SocialEquityUserLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
SocialEquityUserLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialEquityUserLocalService
extends PersistedModelLocalService

The interface for the social equity user local service.

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.

See Also:
SocialEquityUserLocalServiceUtil, com.liferay.portlet.social.service.base.SocialEquityUserLocalServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialEquityUserLocalServiceImpl

Method Summary
 SocialEquityUser addSocialEquityUser(SocialEquityUser socialEquityUser)
          Adds the social equity user to the database.
 void clearRanks(long userId)
          Removes ranking for the user with respect to all groups.
 SocialEquityUser createSocialEquityUser(long equityUserId)
          Creates a new social equity user with the primary key.
 void deleteSocialEquityUser(long equityUserId)
          Deletes the social equity user with the primary key from the database.
 void deleteSocialEquityUser(SocialEquityUser socialEquityUser)
          Deletes the social equity user from the database.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 SocialEquityValue getContributionEquity(long userId)
          Returns the contribution equity score for the user.
 SocialEquityValue getContributionEquity(long userId, long groupId)
          Returns the contribution equity score of the user with respect to the group.
 SocialEquityValue getParticipationEquity(long userId)
          Returns the participation equity score for the user.
 SocialEquityValue getParticipationEquity(long userId, long groupId)
          Returns the participation equity score of the user with respect to the group.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 int getRank(long groupId, long userId)
          Returns the rank of the user in the group based on the user's personal equity.
 List<SocialEquityUser> getRankedEquityUsers(long groupId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the social equity users in the group with rankings greater than zero.
 int getRankedEquityUsersCount(long groupId)
          Returns the number of the social equity users in the group with rankings greater than zero.
 SocialEquityUser getSocialEquityUser(long equityUserId)
          Returns the social equity user with the primary key.
 List<SocialEquityUser> getSocialEquityUsers(int start, int end)
          Returns a range of all the social equity users.
 int getSocialEquityUsersCount()
          Returns the number of social equity users.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser)
          Updates the social equity user in the database or adds it if it does not yet exist.
 SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser, boolean merge)
          Updates the social equity user in the database or adds it if it does not yet exist.
 

Method Detail

addSocialEquityUser

SocialEquityUser addSocialEquityUser(SocialEquityUser socialEquityUser)
                                     throws SystemException
Adds the social equity user to the database. Also notifies the appropriate model listeners.

Parameters:
socialEquityUser - the social equity user
Returns:
the social equity user that was added
Throws:
SystemException - if a system exception occurred

createSocialEquityUser

SocialEquityUser createSocialEquityUser(long equityUserId)
Creates a new social equity user with the primary key. Does not add the social equity user to the database.

Parameters:
equityUserId - the primary key for the new social equity user
Returns:
the new social equity user

deleteSocialEquityUser

void deleteSocialEquityUser(long equityUserId)
                            throws PortalException,
                                   SystemException
Deletes the social equity user with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
equityUserId - the primary key of the social equity user
Throws:
PortalException - if a social equity user with the primary key could not be found
SystemException - if a system exception occurred

deleteSocialEquityUser

void deleteSocialEquityUser(SocialEquityUser socialEquityUser)
                            throws SystemException
Deletes the social equity user from the database. Also notifies the appropriate model listeners.

Parameters:
socialEquityUser - the social equity user
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getSocialEquityUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityUser getSocialEquityUser(long equityUserId)
                                     throws PortalException,
                                            SystemException
Returns the social equity user with the primary key.

Parameters:
equityUserId - the primary key of the social equity user
Returns:
the social equity user
Throws:
PortalException - if a social equity user with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getSocialEquityUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquityUser> getSocialEquityUsers(int start,
                                                                                     int end)
                                            throws SystemException
Returns a range of all the social equity users.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of social equity users
end - the upper bound of the range of social equity users (not inclusive)
Returns:
the range of social equity users
Throws:
SystemException - if a system exception occurred

getSocialEquityUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSocialEquityUsersCount()
                              throws SystemException
Returns the number of social equity users.

Returns:
the number of social equity users
Throws:
SystemException - if a system exception occurred

updateSocialEquityUser

SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser)
                                        throws SystemException
Updates the social equity user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
socialEquityUser - the social equity user
Returns:
the social equity user that was updated
Throws:
SystemException - if a system exception occurred

updateSocialEquityUser

SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser,
                                        boolean merge)
                                        throws SystemException
Updates the social equity user in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
socialEquityUser - the social equity user
merge - whether to merge the social equity user with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the social equity user that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

clearRanks

void clearRanks(long userId)
                throws SystemException
Removes ranking for the user with respect to all groups.

This method is called by the portal when a user is deactivated.

Parameters:
userId - the primary key of the user
Throws:
SystemException - if a system exception occurred

getContributionEquity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityValue getContributionEquity(long userId)
                                        throws SystemException
Returns the contribution equity score for the user.

This method should only be used if social equity is turned on for only one group, as it returns the contribution score for the first group it finds. The first group found can be different from one execution to the next.

Parameters:
userId - the primary key of the user
Returns:
the contribution equity score
Throws:
SystemException - if a system exception occurred

getContributionEquity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityValue getContributionEquity(long userId,
                                                                                 long groupId)
                                        throws SystemException
Returns the contribution equity score of the user with respect to the group.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the contribution equity score
Throws:
SystemException - if a system exception occurred

getParticipationEquity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityValue getParticipationEquity(long userId)
                                         throws SystemException
Returns the participation equity score for the user.

This method should only be used if social equity is turned on for only one group, as it returns the participation score for the first group it finds. The first group found can be different from one execution to the next.

Parameters:
userId - the primary key of the user
Returns:
the participation equity score
Throws:
SystemException - if a system exception occurred

getParticipationEquity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityValue getParticipationEquity(long userId,
                                                                                  long groupId)
                                         throws SystemException
Returns the participation equity score of the user with respect to the group.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
the participation equity score
Throws:
SystemException - if a system exception occurred

getRank

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRank(long groupId,
                                                     long userId)
            throws SystemException
Returns the rank of the user in the group based on the user's personal equity.

Parameters:
groupId - the primary key of the group
userId - the primary key of the user
Returns:
the rank for the user in the group
Throws:
SystemException - if a system exception occurred

getRankedEquityUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquityUser> getRankedEquityUsers(long groupId,
                                                                                     int start,
                                                                                     int end,
                                                                                     OrderByComparator orderByComparator)
                                            throws SystemException
Returns an ordered range of all the social equity users in the group with rankings greater than zero. It is strongly suggested to use SocialEquityUserRankComparator as the ordering comparator.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
groupId - the primary key of the group
start - the lower bound of the range of results
end - the upper bound of the range of results (not inclusive)
orderByComparator - the comparator to order the social equity users, such as SocialEquityUserRankComparator (optionally null)
Returns:
the ordered range of the social equity users
Throws:
SystemException - if a system exception occurred

getRankedEquityUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRankedEquityUsersCount(long groupId)
                              throws SystemException
Returns the number of the social equity users in the group with rankings greater than zero.

Parameters:
groupId - the primary key of the group
Returns:
the number of social equity users with rankings greater than zero
Throws:
SystemException - if a system exception occurred

Liferay 6.1.0