com.liferay.portlet.social.service

Class SocialActivityServiceUtil

java.lang.Object

com.liferay.portlet.social.service.SocialActivityServiceUtil

@ProviderType
public class SocialActivityServiceUtil
extends java.lang.Object

Provides the remote service utility for SocialActivity. This utility wraps com.liferay.portlet.social.service.impl.SocialActivityServiceImpl and is the primary access point for service operations in application layer code running on a remote server. 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:

SocialActivityService, com.liferay.portlet.social.service.base.SocialActivityServiceBaseImpl, com.liferay.portlet.social.service.impl.SocialActivityServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
SocialActivityServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.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.
static java.util.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.
static java.util.List<SocialActivity>	getActivities(long mirrorActivityId, java.lang.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.
static java.util.List<SocialActivity>	getActivities(java.lang.String className, int start, int end) Returns a range of all the activities done on assets identified by the class name.
static int	getActivitiesCount(long classNameId) Returns the number of activities done on assets identified by the class name ID.
static 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.
static int	getActivitiesCount(long mirrorActivityId, java.lang.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.
static int	getActivitiesCount(java.lang.String className) Returns the number of activities done on assets identified by class name.
static SocialActivity	getActivity(long activityId) Returns the activity identified by its primary key.
static java.util.List<SocialActivity>	getActivitySetActivities(long activitySetId, int start, int end)
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static java.util.List<SocialActivity>	getGroupActivities(long groupId, int start, int end) Returns a range of all the activities done in the group.
static int	getGroupActivitiesCount(long groupId) Returns the number of activities done in the group.
static java.util.List<SocialActivity>	getGroupUsersActivities(long groupId, int start, int end) Returns a range of activities done by users that are members of the group.
static int	getGroupUsersActivitiesCount(long groupId) Returns the number of activities done by users that are members of the group.
static SocialActivity	getMirrorActivity(long mirrorActivityId) Returns the activity that has the mirror activity.
static java.util.List<SocialActivity>	getOrganizationActivities(long organizationId, int start, int end) Returns a range of all the activities done in the organization.
static int	getOrganizationActivitiesCount(long organizationId) Returns the number of activities done in the organization.
static java.util.List<SocialActivity>	getOrganizationUsersActivities(long organizationId, int start, int end) Returns a range of all the activities done by users of the organization.
static int	getOrganizationUsersActivitiesCount(long organizationId) Returns the number of activities done by users of the organization.
static java.util.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.
static java.util.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.
static int	getRelationActivitiesCount(long userId) Returns the number of activities done by users in a relationship with the user identified by userId.
static 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.
static SocialActivityService	getService()
static java.util.List<SocialActivity>	getUserActivities(long userId, int start, int end) Returns a range of all the activities done by the user.
static int	getUserActivitiesCount(long userId) Returns the number of activities done by the user.
static java.util.List<SocialActivity>	getUserGroupsActivities(long userId, int start, int end) Returns a range of all the activities done in the user's groups.
static int	getUserGroupsActivitiesCount(long userId) Returns the number of activities done in user's groups.
static java.util.List<SocialActivity>	getUserGroupsAndOrganizationsActivities(long userId, int start, int end) Returns a range of all the activities done in the user's groups and organizations.
static int	getUserGroupsAndOrganizationsActivitiesCount(long userId) Returns the number of activities done in user's groups and organizations.
static java.util.List<SocialActivity>	getUserOrganizationsActivities(long userId, int start, int end) Returns a range of all activities done in the user's organizations.
static int	getUserOrganizationsActivitiesCount(long userId) Returns the number of activities done in the user's organizations.
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(SocialActivityService service) Deprecated. As of 6.2.0

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocialActivityServiceUtil

public SocialActivityServiceUtil()

Method Detail

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

getActivities

public static java.util.List<SocialActivity> getActivities(long classNameId,
                                           int start,
                                           int end)
                                                    throws PortalException,
                                                           SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getActivities

public static java.util.List<SocialActivity> getActivities(long mirrorActivityId,
                                           long classNameId,
                                           long classPK,
                                           int start,
                                           int end)
                                                    throws PortalException,
                                                           SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getActivities

public static java.util.List<SocialActivity> getActivities(long mirrorActivityId,
                                           java.lang.String className,
                                           long classPK,
                                           int start,
                                           int end)
                                                    throws PortalException,
                                                           SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getActivities

public static java.util.List<SocialActivity> getActivities(java.lang.String className,
                                           int start,
                                           int end)
                                                    throws PortalException,
                                                           SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getActivitiesCount

public static int getActivitiesCount(long classNameId)
                              throws SystemException

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

Throws:

SystemException - if a system exception occurred

getActivitiesCount

public static int getActivitiesCount(long mirrorActivityId,
                     long classNameId,
                     long classPK)
                              throws SystemException

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

Throws:

SystemException - if a system exception occurred

getActivitiesCount

public static int getActivitiesCount(long mirrorActivityId,
                     java.lang.String className,
                     long classPK)
                              throws SystemException

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

Throws:

SystemException - if a system exception occurred

getActivitiesCount

public static int getActivitiesCount(java.lang.String className)
                              throws SystemException

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

Throws:

SystemException - if a system exception occurred

getActivity

public static SocialActivity getActivity(long activityId)
                                  throws PortalException,
                                         SystemException

Returns the activity identified by its primary key.

Parameters:

activityId - the primary key of the activity

Returns:

Returns the activity

Throws:

PortalException - if the activity could not be found

SystemException - if a system exception occurred

getActivitySetActivities

public static java.util.List<SocialActivity> getActivitySetActivities(long activitySetId,
                                                      int start,
                                                      int end)
                                                               throws PortalException,
                                                                      SystemException

Throws:

PortalException

SystemException

getGroupActivities

public static java.util.List<SocialActivity> getGroupActivities(long groupId,
                                                int start,
                                                int end)
                                                         throws PortalException,
                                                                SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getGroupActivitiesCount

public static int getGroupActivitiesCount(long groupId)
                                   throws SystemException

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

Throws:

SystemException - if a system exception occurred

getGroupUsersActivities

public static java.util.List<SocialActivity> getGroupUsersActivities(long groupId,
                                                     int start,
                                                     int end)
                                                              throws PortalException,
                                                                     SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getGroupUsersActivitiesCount

public static int getGroupUsersActivitiesCount(long groupId)
                                        throws SystemException

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

Throws:

SystemException - if a system exception occurred

getMirrorActivity

public static SocialActivity getMirrorActivity(long mirrorActivityId)
                                        throws PortalException,
                                               SystemException

Returns the activity that has the mirror activity.

Parameters:

mirrorActivityId - the primary key of the mirror activity

Returns:

Returns the mirror activity

Throws:

PortalException - if the mirror activity could not be found

SystemException - if a system exception occurred

getOrganizationActivities

public static java.util.List<SocialActivity> getOrganizationActivities(long organizationId,
                                                       int start,
                                                       int end)
                                                                throws PortalException,
                                                                       SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getOrganizationActivitiesCount

public static int getOrganizationActivitiesCount(long organizationId)
                                          throws SystemException

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

Throws:

SystemException - if a system exception occurred

getOrganizationUsersActivities

public static java.util.List<SocialActivity> getOrganizationUsersActivities(long organizationId,
                                                            int start,
                                                            int end)
                                                                     throws PortalException,
                                                                            SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getOrganizationUsersActivitiesCount

public static int getOrganizationUsersActivitiesCount(long organizationId)
                                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

getRelationActivities

public static java.util.List<SocialActivity> getRelationActivities(long userId,
                                                   int start,
                                                   int end)
                                                            throws PortalException,
                                                                   SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getRelationActivities

public static java.util.List<SocialActivity> getRelationActivities(long userId,
                                                   int type,
                                                   int start,
                                                   int end)
                                                            throws PortalException,
                                                                   SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getRelationActivitiesCount

public static int getRelationActivitiesCount(long userId)
                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getRelationActivitiesCount

public static int getRelationActivitiesCount(long userId,
                             int type)
                                      throws SystemException

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

Throws:

SystemException - if a system exception occurred

getUserActivities

public static java.util.List<SocialActivity> getUserActivities(long userId,
                                               int start,
                                               int end)
                                                        throws PortalException,
                                                               SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getUserActivitiesCount

public static int getUserActivitiesCount(long userId)
                                  throws SystemException

Returns the number of activities done by the user.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

Throws:

SystemException - if a system exception occurred

getUserGroupsActivities

public static java.util.List<SocialActivity> getUserGroupsActivities(long userId,
                                                     int start,
                                                     int end)
                                                              throws PortalException,
                                                                     SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getUserGroupsActivitiesCount

public static int getUserGroupsActivitiesCount(long userId)
                                        throws SystemException

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

Throws:

SystemException - if a system exception occurred

getUserGroupsAndOrganizationsActivities

public static java.util.List<SocialActivity> getUserGroupsAndOrganizationsActivities(long userId,
                                                                     int start,
                                                                     int end)
                                                                              throws PortalException,
                                                                                     SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getUserGroupsAndOrganizationsActivitiesCount

public static int getUserGroupsAndOrganizationsActivitiesCount(long userId)
                                                        throws SystemException

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

Throws:

SystemException - if a system exception occurred

getUserOrganizationsActivities

public static java.util.List<SocialActivity> getUserOrganizationsActivities(long userId,
                                                            int start,
                                                            int end)
                                                                     throws PortalException,
                                                                            SystemException

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 - if a permission checker was not initialized

SystemException - if a system exception occurred

getUserOrganizationsActivitiesCount

public static int getUserOrganizationsActivitiesCount(long userId)
                                               throws SystemException

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

Throws:

SystemException - if a system exception occurred

getService

public static SocialActivityService getService()

setService

public void setService(SocialActivityService service)

Deprecated. As of 6.2.0