|
Liferay 6.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.social.service.SocialEquityUserLocalServiceUtil
public class SocialEquityUserLocalServiceUtil
The utility for the social equity user local service. This utility wraps 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.
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.
SocialEquityUserLocalService,
com.liferay.portlet.social.service.base.SocialEquityUserLocalServiceBaseImpl,
com.liferay.portlet.social.service.impl.SocialEquityUserLocalServiceImpl| Constructor Summary | |
|---|---|
SocialEquityUserLocalServiceUtil()
|
|
| Method Summary | |
|---|---|
static SocialEquityUser |
addSocialEquityUser(SocialEquityUser socialEquityUser)
Adds the social equity user to the database. |
static void |
clearRanks(long userId)
Removes ranking for the user with respect to all groups. |
static SocialEquityUser |
createSocialEquityUser(long equityUserId)
Creates a new social equity user with the primary key. |
static void |
deleteSocialEquityUser(long equityUserId)
Deletes the social equity user with the primary key from the database. |
static void |
deleteSocialEquityUser(SocialEquityUser socialEquityUser)
Deletes the social equity user from the database. |
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static 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. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static SocialEquityValue |
getContributionEquity(long userId)
Returns the contribution equity score for the user. |
static SocialEquityValue |
getContributionEquity(long userId,
long groupId)
Returns the contribution equity score of the user with respect to the group. |
static SocialEquityValue |
getParticipationEquity(long userId)
Returns the participation equity score for the user. |
static SocialEquityValue |
getParticipationEquity(long userId,
long groupId)
Returns the participation equity score of the user with respect to the group. |
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static int |
getRank(long groupId,
long userId)
Returns the rank of the user in the group based on the user's personal equity. |
static 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. |
static int |
getRankedEquityUsersCount(long groupId)
Returns the number of the social equity users in the group with rankings greater than zero. |
static SocialEquityUserLocalService |
getService()
|
static SocialEquityUser |
getSocialEquityUser(long equityUserId)
Returns the social equity user with the primary key. |
static List<SocialEquityUser> |
getSocialEquityUsers(int start,
int end)
Returns a range of all the social equity users. |
static int |
getSocialEquityUsersCount()
Returns the number of social equity users. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(SocialEquityUserLocalService service)
|
static SocialEquityUser |
updateSocialEquityUser(SocialEquityUser socialEquityUser)
Updates the social equity user in the database or adds it if it does not yet exist. |
static SocialEquityUser |
updateSocialEquityUser(SocialEquityUser socialEquityUser,
boolean merge)
Updates the social equity user in the database or adds it if it does not yet exist. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public SocialEquityUserLocalServiceUtil()
| Method Detail |
|---|
public static SocialEquityUser addSocialEquityUser(SocialEquityUser socialEquityUser)
throws SystemException
socialEquityUser - the social equity user
SystemException - if a system exception occurredpublic static SocialEquityUser createSocialEquityUser(long equityUserId)
equityUserId - the primary key for the new social equity user
public static void deleteSocialEquityUser(long equityUserId)
throws PortalException,
SystemException
equityUserId - the primary key of the social equity user
PortalException - if a social equity user with the primary key could not be found
SystemException - if a system exception occurred
public static void deleteSocialEquityUser(SocialEquityUser socialEquityUser)
throws SystemException
socialEquityUser - the social equity user
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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.
dynamicQuery - the dynamic querystart - the lower bound of the range of model instancesend - the upper bound of the range of model instances (not inclusive)orderByComparator - the comparator to order the results by (optionally null)
SystemException - if a system exception occurred
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static SocialEquityUser getSocialEquityUser(long equityUserId)
throws PortalException,
SystemException
equityUserId - the primary key of the social equity user
PortalException - if a social equity user with the primary key could not be found
SystemException - if a system exception occurred
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
PortalException
SystemException
public static List<SocialEquityUser> getSocialEquityUsers(int start,
int end)
throws SystemException
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.
start - the lower bound of the range of social equity usersend - the upper bound of the range of social equity users (not inclusive)
SystemException - if a system exception occurred
public static int getSocialEquityUsersCount()
throws SystemException
SystemException - if a system exception occurred
public static SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser)
throws SystemException
socialEquityUser - the social equity user
SystemException - if a system exception occurred
public static SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser,
boolean merge)
throws SystemException
socialEquityUser - the social equity usermerge - 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.
SystemException - if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static void clearRanks(long userId)
throws SystemException
This method is called by the portal when a user is deactivated.
userId - the primary key of the user
SystemException - if a system exception occurred
public static SocialEquityValue getContributionEquity(long userId)
throws SystemException
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.
userId - the primary key of the user
SystemException - if a system exception occurred
public static SocialEquityValue getContributionEquity(long userId,
long groupId)
throws SystemException
userId - the primary key of the usergroupId - the primary key of the group
SystemException - if a system exception occurred
public static SocialEquityValue getParticipationEquity(long userId)
throws SystemException
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.
userId - the primary key of the user
SystemException - if a system exception occurred
public static SocialEquityValue getParticipationEquity(long userId,
long groupId)
throws SystemException
userId - the primary key of the usergroupId - the primary key of the group
SystemException - if a system exception occurred
public static int getRank(long groupId,
long userId)
throws SystemException
groupId - the primary key of the groupuserId - the primary key of the user
SystemException - if a system exception occurred
public static List<SocialEquityUser> getRankedEquityUsers(long groupId,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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.
groupId - the primary key of the groupstart - the lower bound of the range of resultsend - the upper bound of the range of results (not inclusive)orderByComparator - the comparator to order the social equity
users, such as SocialEquityUserRankComparator
(optionally null)
SystemException - if a system exception occurred
public static int getRankedEquityUsersCount(long groupId)
throws SystemException
groupId - the primary key of the group
SystemException - if a system exception occurredpublic static SocialEquityUserLocalService getService()
public void setService(SocialEquityUserLocalService service)
|
Liferay 6.1.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||