com.liferay.social.kernel.service

Interface SocialActivityService

All Superinterfaces:

BaseService

All Known Implementing Classes:

SocialActivityServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SocialActivityService
extends BaseService

Provides the remote service interface for SocialActivity. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

SocialActivityServiceUtil, SocialActivityServiceBaseImpl, SocialActivityServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
List<SocialActivity>	getActivities(long classNameId, int start, int end) Returns a range of all the activities done on assets identified by the class name ID.
List<SocialActivity>	getActivities(long mirrorActivityId, long classNameId, long classPK, int start, int end) Returns a range of all the activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.
List<SocialActivity>	getActivities(long mirrorActivityId, String className, long classPK, int start, int end) Returns a range of all the activities done on the asset identified by the class name and the class primary key that are mirrors of the activity identified by the mirror activity ID.
List<SocialActivity>	getActivities(String className, int start, int end) Returns a range of all the activities done on assets identified by the class name.
int	getActivitiesCount(long classNameId) Returns the number of activities done on assets identified by the class name ID.
int	getActivitiesCount(long mirrorActivityId, long classNameId, long classPK) Returns the number of activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.
int	getActivitiesCount(long mirrorActivityId, String className, long classPK) Returns the number of activities done on the asset identified by the class name and class primary key that are mirrors of the activity identified by the mirror activity ID.
int	getActivitiesCount(String className) Returns the number of activities done on assets identified by class name.
SocialActivity	getActivity(long activityId) Returns the activity identified by its primary key.
List<SocialActivity>	getActivitySetActivities(long activitySetId, int start, int end)
List<SocialActivity>	getGroupActivities(long groupId, int start, int end) Returns a range of all the activities done in the group.
int	getGroupActivitiesCount(long groupId) Returns the number of activities done in the group.
List<SocialActivity>	getGroupUsersActivities(long groupId, int start, int end) Returns a range of activities done by users that are members of the group.
int	getGroupUsersActivitiesCount(long groupId) Returns the number of activities done by users that are members of the group.
SocialActivity	getMirrorActivity(long mirrorActivityId) Returns the activity that has the mirror activity.
List<SocialActivity>	getOrganizationActivities(long organizationId, int start, int end) Returns a range of all the activities done in the organization.
int	getOrganizationActivitiesCount(long organizationId) Returns the number of activities done in the organization.
List<SocialActivity>	getOrganizationUsersActivities(long organizationId, int start, int end) Returns a range of all the activities done by users of the organization.
int	getOrganizationUsersActivitiesCount(long organizationId) Returns the number of activities done by users of the organization.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
List<SocialActivity>	getRelationActivities(long userId, int start, int end) Returns a range of all the activities done by users in a relationship with the user identified by the user ID.
List<SocialActivity>	getRelationActivities(long userId, int type, int start, int end) Returns a range of all the activities done by users in a relationship of type type with the user identified by userId.
int	getRelationActivitiesCount(long userId) Returns the number of activities done by users in a relationship with the user identified by userId.
int	getRelationActivitiesCount(long userId, int type) Returns the number of activities done by users in a relationship of type type with the user identified by userId.
List<SocialActivity>	getUserActivities(long userId, int start, int end) Returns a range of all the activities done by the user.
int	getUserActivitiesCount(long userId) Returns the number of activities done by the user.
List<SocialActivity>	getUserGroupsActivities(long userId, int start, int end) Returns a range of all the activities done in the user's groups.
int	getUserGroupsActivitiesCount(long userId) Returns the number of activities done in user's groups.
List<SocialActivity>	getUserGroupsAndOrganizationsActivities(long userId, int start, int end) Returns a range of all the activities done in the user's groups and organizations.
int	getUserGroupsAndOrganizationsActivitiesCount(long userId) Returns the number of activities done in user's groups and organizations.
List<SocialActivity>	getUserOrganizationsActivities(long userId, int start, int end) Returns a range of all activities done in the user's organizations.
int	getUserOrganizationsActivitiesCount(long userId) Returns the number of activities done in the user's organizations.

Method Detail

getActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getActivities(long classNameId,
                                                                                                      int start,
                                                                                                      int end)
                                                                                               throws PortalException

Returns a range of all the activities done on assets identified by the class name ID.

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:

classNameId - the target asset's class name ID

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getActivities(long mirrorActivityId,
                                                                                                      long classNameId,
                                                                                                      long classPK,
                                                                                                      int start,
                                                                                                      int end)
                                                                                               throws PortalException

Returns a range of all the activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.

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:

mirrorActivityId - the primary key of the mirror activity

classNameId - the target asset's class name ID

classPK - the primary key of the target asset

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getActivities(long mirrorActivityId,
                                                                                                      String className,
                                                                                                      long classPK,
                                                                                                      int start,
                                                                                                      int end)
                                                                                               throws PortalException

Returns a range of all the activities done on the asset identified by the class name and the class primary key that are mirrors of the activity identified by the mirror activity ID.

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:

mirrorActivityId - the primary key of the mirror activity

className - the target asset's class name

classPK - the primary key of the target asset

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getActivities(String className,
                                                                                                      int start,
                                                                                                      int end)
                                                                                               throws PortalException

Returns a range of all the activities done on assets identified by the class name.

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:

className - the target asset's class name

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getActivitiesCount(long classNameId)

Returns the number of activities done on assets identified by the class name ID.

Parameters:

classNameId - the target asset's class name ID

Returns:

the number of matching activities

getActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getActivitiesCount(long mirrorActivityId,
                                                                                          long classNameId,
                                                                                          long classPK)

Returns the number of activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.

Parameters:

mirrorActivityId - the primary key of the mirror activity

classNameId - the target asset's class name ID

classPK - the primary key of the target asset

Returns:

the number of matching activities

getActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getActivitiesCount(long mirrorActivityId,
                                                                                          String className,
                                                                                          long classPK)

Returns the number of activities done on the asset identified by the class name and class primary key that are mirrors of the activity identified by the mirror activity ID.

Parameters:

mirrorActivityId - the primary key of the mirror activity

className - the target asset's class name

classPK - the primary key of the target asset

Returns:

the number of matching activities

getActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getActivitiesCount(String className)

Returns the number of activities done on assets identified by class name.

Parameters:

className - the target asset's class name

Returns:

the number of matching activities

getActivity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivity getActivity(long activityId)
                                                                                       throws PortalException

Returns the activity identified by its primary key.

Parameters:

activityId - the primary key of the activity

Returns:

Returns the activity

Throws:

PortalException

getActivitySetActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getActivitySetActivities(long activitySetId,
                                                                                                                 int start,
                                                                                                                 int end)
                                                                                                          throws PortalException

Throws:

PortalException

getGroupActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getGroupActivities(long groupId,
                                                                                                           int start,
                                                                                                           int end)
                                                                                                    throws PortalException

Returns a range of all the activities done in the group.

This method only finds activities without mirrors.

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)

Returns:

the range of matching activities

Throws:

PortalException

getGroupActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupActivitiesCount(long groupId)

Returns the number of activities done in the group.

This method only counts activities without mirrors.

Parameters:

groupId - the primary key of the group

Returns:

the number of matching activities

getGroupUsersActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getGroupUsersActivities(long groupId,
                                                                                                                int start,
                                                                                                                int end)
                                                                                                         throws PortalException

Returns a range of activities done by users that are members of the group.

This method only finds activities without mirrors.

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)

Returns:

the range of matching activities

Throws:

PortalException

getGroupUsersActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupUsersActivitiesCount(long groupId)

Returns the number of activities done by users that are members of the group.

This method only counts activities without mirrors.

Parameters:

groupId - the primary key of the group

Returns:

the number of matching activities

getMirrorActivity

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SocialActivity getMirrorActivity(long mirrorActivityId)
                                                                                             throws PortalException

Returns the activity that has the mirror activity.

Parameters:

mirrorActivityId - the primary key of the mirror activity

Returns:

Returns the mirror activity

Throws:

PortalException

getOrganizationActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getOrganizationActivities(long organizationId,
                                                                                                                  int start,
                                                                                                                  int end)
                                                                                                           throws PortalException

Returns a range of all the activities done in the organization. This method only finds activities without mirrors.

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:

organizationId - the primary key of the organization

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getOrganizationActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationActivitiesCount(long organizationId)

Returns the number of activities done in the organization. This method only counts activities without mirrors.

Parameters:

organizationId - the primary key of the organization

Returns:

the number of matching activities

getOrganizationUsersActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getOrganizationUsersActivities(long organizationId,
                                                                                                                       int start,
                                                                                                                       int end)
                                                                                                                throws PortalException

Returns a range of all the activities done by users of the organization. This method only finds activities without mirrors.

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:

organizationId - the primary key of the organization

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getOrganizationUsersActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOrganizationUsersActivitiesCount(long organizationId)

Returns the number of activities done by users of the organization. This method only counts activities without mirrors.

Parameters:

organizationId - the primary key of the organization

Returns:

the number of matching activities

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getRelationActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getRelationActivities(long userId,
                                                                                                              int start,
                                                                                                              int end)
                                                                                                       throws PortalException

Returns a range of all the activities done by users in a relationship with the user identified by the user ID.

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:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getRelationActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getRelationActivities(long userId,
                                                                                                              int type,
                                                                                                              int start,
                                                                                                              int end)
                                                                                                       throws PortalException

Returns a range of all the activities done by users in a relationship of type type with the user identified by userId. This method only finds activities without mirrors.

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:

userId - the primary key of the user

type - the relationship type

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getRelationActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRelationActivitiesCount(long userId)

Returns the number of activities done by users in a relationship with the user identified by userId.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

getRelationActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRelationActivitiesCount(long userId,
                                                                                                  int type)

Returns the number of activities done by users in a relationship of type type with the user identified by userId. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

type - the relationship type

Returns:

the number of matching activities

getUserActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getUserActivities(long userId,
                                                                                                          int start,
                                                                                                          int end)
                                                                                                   throws PortalException

Returns a range of all the activities done by the user.

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:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getUserActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserActivitiesCount(long userId)

Returns the number of activities done by the user.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

getUserGroupsActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getUserGroupsActivities(long userId,
                                                                                                                int start,
                                                                                                                int end)
                                                                                                         throws PortalException

Returns a range of all the activities done in the user's groups. This method only finds activities without mirrors.

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:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getUserGroupsActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsActivitiesCount(long userId)

Returns the number of activities done in user's groups. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

getUserGroupsAndOrganizationsActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getUserGroupsAndOrganizationsActivities(long userId,
                                                                                                                                int start,
                                                                                                                                int end)
                                                                                                                         throws PortalException

Returns a range of all the activities done in the user's groups and organizations. This method only finds activities without mirrors.

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:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getUserGroupsAndOrganizationsActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsAndOrganizationsActivitiesCount(long userId)

Returns the number of activities done in user's groups and organizations. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

getUserOrganizationsActivities

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<SocialActivity> getUserOrganizationsActivities(long userId,
                                                                                                                       int start,
                                                                                                                       int end)
                                                                                                                throws PortalException

Returns a range of all activities done in the user's organizations. This method only finds activities without mirrors.

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:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

PortalException

getUserOrganizationsActivitiesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserOrganizationsActivitiesCount(long userId)

Returns the number of activities done in the user's organizations. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities