Liferay 6.0.5

com.liferay.portlet.social.service
Interface SocialEquityUserLocalService

All Known Implementing Classes:
SocialEquityUserLocalServiceBaseImpl, SocialEquityUserLocalServiceImpl, SocialEquityUserLocalServiceWrapper

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

The interface for the social equity user local service.

Never modify or reference this interface directly. Always use SocialEquityUserLocalServiceUtil to access the social equity user local service. Add custom service methods to SocialEquityUserLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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, SocialEquityUserLocalServiceBaseImpl, SocialEquityUserLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 SocialEquityUser addSocialEquityUser(SocialEquityUser socialEquityUser)
          Adds the social equity user to the database.
 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)
          Counts the number of rows that match the dynamic query.
 SocialEquityValue getContributionEquity(long userId)
           
 SocialEquityValue getParticipationEquity(long userId)
           
 List<SocialEquityUser> getRankedSocialEquityUsers(long groupId, int start, int end, OrderByComparator orderByComparator)
           
 int getRankedSocialEquityUsersCount(long groupId)
           
 SocialEquityUser getSocialEquityUser(long equityUserId)
          Gets the social equity user with the primary key.
 List<SocialEquityUser> getSocialEquityUsers(int start, int end)
          Gets a range of all the social equity users.
 int getSocialEquityUsersCount()
          Gets the number of social equity users.
 SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser)
          Updates the social equity user in the database.
 SocialEquityUser updateSocialEquityUser(SocialEquityUser socialEquityUser, boolean merge)
          Updates the social equity user in the database.
 

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 to add
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 to delete
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 to delete
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 to search with
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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

Parameters:
dynamicQuery - the dynamic query to search with
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
Gets the social equity user with the primary key.

Parameters:
equityUserId - the primary key of the social equity user to get
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

getSocialEquityUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquityUser> getSocialEquityUsers(int start,
                                                                                     int end)
                                            throws SystemException
Gets 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 to return
end - the upper bound of the range of social equity users to return (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
Gets 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. Also notifies the appropriate model listeners.

Parameters:
socialEquityUser - the social equity user to update
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. Also notifies the appropriate model listeners.

Parameters:
socialEquityUser - the social equity user to update
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

getContributionEquity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityValue getContributionEquity(long userId)
                                        throws SystemException
Throws:
SystemException

getParticipationEquity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialEquityValue getParticipationEquity(long userId)
                                         throws SystemException
Throws:
SystemException

getRankedSocialEquityUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialEquityUser> getRankedSocialEquityUsers(long groupId,
                                                                                           int start,
                                                                                           int end,
                                                                                           OrderByComparator orderByComparator)
                                                  throws SystemException
Throws:
SystemException

getRankedSocialEquityUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRankedSocialEquityUsersCount(long groupId)
                                    throws SystemException
Throws:
SystemException

Liferay 6.0.5