com.liferay.portlet.social.service
Class SocialActivityLocalServiceUtil

java.lang.Object
  com.liferay.portlet.social.service.SocialActivityLocalServiceUtil

public class SocialActivityLocalServiceUtil
extends Object

The utility for the social activity local service. This utility wraps SocialActivityLocalServiceImpl 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.

See Also:

SocialActivityLocalService, SocialActivityLocalServiceBaseImpl, SocialActivityLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

SocialActivityLocalServiceUtil()

Method Summary

static void	addActivity(long userId, long groupId, Date createDate, String className, long classPK, int type, String extraData, long receiverUserId) Records an activity with the given time in the database.
static void	addActivity(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) Records an activity in the database, using a time based on the current time in an attempt to make the activity's time unique.
static void	addActivity(SocialActivity activity, SocialActivity mirrorActivity)
static SocialActivity	addSocialActivity(SocialActivity socialActivity) Adds the social activity to the database.
static void	addUniqueActivity(long userId, long groupId, Date createDate, String className, long classPK, int type, String extraData, long receiverUserId) Records an activity in the database, but only if there isn't already an activity with the same parameters.
static void	addUniqueActivity(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) Records an activity with the current time in the database, but only if there isn't one with the same parameters.
static SocialActivity	createSocialActivity(long activityId) Creates a new social activity with the primary key.
static void	deleteActivities(AssetEntry assetEntry) Removes stored activities for the asset identified by the class name ID and class primary key.
static void	deleteActivities(String className, long classPK) Removes stored activities for the asset identified by the class name and class primary key.
static void	deleteActivity(long activityId) Removes the stored activity from the database.
static void	deleteActivity(SocialActivity activity) Removes the stored activity and its mirror activity from the database.
static SocialActivity	deleteSocialActivity(long activityId) Deletes the social activity with the primary key from the database.
static SocialActivity	deleteSocialActivity(SocialActivity socialActivity) Deletes the social activity from the database.
static void	deleteUserActivities(long userId) Removes the user's stored activities from the database.
static DynamicQuery	dynamicQuery()
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 SocialActivity	fetchSocialActivity(long activityId)
static 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 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 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.
static List<SocialActivity>	getActivities(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, 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(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 String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static 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 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 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 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 PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static 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 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 SocialActivityLocalService	getService()
static List<SocialActivity>	getSocialActivities(int start, int end) Returns a range of all the social activities.
static int	getSocialActivitiesCount() Returns the number of social activities.
static SocialActivity	getSocialActivity(long activityId) Returns the social activity with the primary key.
static 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 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 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 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(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(SocialActivityLocalService service) Deprecated.
static SocialActivity	updateSocialActivity(SocialActivity socialActivity) Updates the social activity in the database or adds it if it does not yet exist.
static SocialActivity	updateSocialActivity(SocialActivity socialActivity, boolean merge) Updates the social activity 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

SocialActivityLocalServiceUtil

public SocialActivityLocalServiceUtil()

Method Detail

addSocialActivity

public static SocialActivity addSocialActivity(SocialActivity socialActivity)
                                        throws SystemException

Adds the social activity to the database. Also notifies the appropriate model listeners.

Parameters:

socialActivity - the social activity

Returns:

the social activity that was added

Throws:

SystemException - if a system exception occurred

createSocialActivity

public static SocialActivity createSocialActivity(long activityId)

Creates a new social activity with the primary key. Does not add the social activity to the database.

Parameters:

activityId - the primary key for the new social activity

Returns:

the new social activity

deleteSocialActivity

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

Deletes the social activity with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

activityId - the primary key of the social activity

Returns:

the social activity that was removed

Throws:

PortalException - if a social activity with the primary key could not be found

SystemException - if a system exception occurred

deleteSocialActivity

public static SocialActivity deleteSocialActivity(SocialActivity socialActivity)
                                           throws SystemException

Deletes the social activity from the database. Also notifies the appropriate model listeners.

Parameters:

socialActivity - the social activity

Returns:

the social activity that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static 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

public static 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

public static 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

public static 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

fetchSocialActivity

public static SocialActivity fetchSocialActivity(long activityId)
                                          throws SystemException

Throws:

SystemException

getSocialActivity

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

Returns the social activity with the primary key.

Parameters:

activityId - the primary key of the social activity

Returns:

the social activity

Throws:

PortalException - if a social activity with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getSocialActivities

public static List<SocialActivity> getSocialActivities(int start,
                                                       int end)
                                                throws SystemException

Returns a range of all the social activities.

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 activities

end - the upper bound of the range of social activities (not inclusive)

Returns:

the range of social activities

Throws:

SystemException - if a system exception occurred

getSocialActivitiesCount

public static int getSocialActivitiesCount()
                                    throws SystemException

Returns the number of social activities.

Returns:

the number of social activities

Throws:

SystemException - if a system exception occurred

updateSocialActivity

public static SocialActivity updateSocialActivity(SocialActivity socialActivity)
                                           throws SystemException

Updates the social activity in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialActivity - the social activity

Returns:

the social activity that was updated

Throws:

SystemException - if a system exception occurred

updateSocialActivity

public static SocialActivity updateSocialActivity(SocialActivity socialActivity,
                                                  boolean merge)
                                           throws SystemException

Updates the social activity in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

socialActivity - the social activity

merge - whether to merge the social activity 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 activity that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addActivity

public static void addActivity(long userId,
                               long groupId,
                               Date createDate,
                               String className,
                               long classPK,
                               int type,
                               String extraData,
                               long receiverUserId)
                        throws PortalException,
                               SystemException

Records an activity with the given time in the database.

This method records a social activity done on an asset, identified by its class name and class primary key, in the database. Additional information (such as the original message ID for a reply to a forum post) is passed in via the extraData in JSON format. For activities affecting another user, a mirror activity is generated that describes the action from the user's point of view. The target user's ID is passed in via the receiverUserId.

Example for a mirrored activity:
When a user replies to a message boards post, the reply action is stored in the database with the receiverUserId being the ID of the author of the original message. The extraData contains the ID of the original message in JSON format. A mirror activity is generated with the values of the userId and the receiverUserId swapped. This mirror activity basically describes a "replied to" event.

Mirror activities are most often used in relation to friend requests and activities.

Parameters:

userId - the primary key of the acting user

groupId - the primary key of the group

createDate - the activity's date

className - the target asset's class name

classPK - the primary key of the target asset

type - the activity's type

extraData - any extra data regarding the activity

receiverUserId - the primary key of the receiving user

Throws:

PortalException - if the user or group could not be found

SystemException - if a system exception occurred

addActivity

public static void addActivity(long userId,
                               long groupId,
                               String className,
                               long classPK,
                               int type,
                               String extraData,
                               long receiverUserId)
                        throws PortalException,
                               SystemException

Records an activity in the database, using a time based on the current time in an attempt to make the activity's time unique.

Parameters:

userId - the primary key of the acting user

groupId - the primary key of the group

className - the target asset's class name

classPK - the primary key of the target asset

type - the activity's type

extraData - any extra data regarding the activity

receiverUserId - the primary key of the receiving user

Throws:

PortalException - if the user or group could not be found

SystemException - if a system exception occurred

addActivity

public static void addActivity(SocialActivity activity,
                               SocialActivity mirrorActivity)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addUniqueActivity

public static void addUniqueActivity(long userId,
                                     long groupId,
                                     Date createDate,
                                     String className,
                                     long classPK,
                                     int type,
                                     String extraData,
                                     long receiverUserId)
                              throws PortalException,
                                     SystemException

Records an activity in the database, but only if there isn't already an activity with the same parameters.

For the main functionality see addActivity(long, long, Date, String, long, int, String, long)

Parameters:

userId - the primary key of the acting user

groupId - the primary key of the group

createDate - the activity's date

className - the target asset's class name

classPK - the primary key of the target asset

type - the activity's type

extraData - any extra data regarding the activity

receiverUserId - the primary key of the receiving user

Throws:

PortalException - if the user or group could not be found

SystemException - if a system exception occurred

addUniqueActivity

public static void addUniqueActivity(long userId,
                                     long groupId,
                                     String className,
                                     long classPK,
                                     int type,
                                     String extraData,
                                     long receiverUserId)
                              throws PortalException,
                                     SystemException

Records an activity with the current time in the database, but only if there isn't one with the same parameters.

For the main functionality see addActivity(long, long, Date, String, long, int, String, long)

Parameters:

userId - the primary key of the acting user

groupId - the primary key of the group

className - the target asset's class name

classPK - the primary key of the target asset

type - the activity's type

extraData - any extra data regarding the activity

receiverUserId - the primary key of the receiving user

Throws:

PortalException - if the user or group could not be found

SystemException - if a system exception occurred

deleteActivities

public static void deleteActivities(AssetEntry assetEntry)
                             throws PortalException,
                                    SystemException

Removes stored activities for the asset identified by the class name ID and class primary key.

Parameters:

assetEntry - the asset from which to remove stored activities

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

deleteActivities

public static void deleteActivities(String className,
                                    long classPK)
                             throws SystemException

Removes stored activities for the asset identified by the class name and class primary key.

Parameters:

className - the target asset's class name

classPK - the primary key of the target asset

Throws:

SystemException - if a system exception occurred

deleteActivity

public static void deleteActivity(long activityId)
                           throws PortalException,
                                  SystemException

Removes the stored activity from the database.

Parameters:

activityId - the primary key of the stored activity

Throws:

PortalException - if the activity could not be found

SystemException - if a system exception occurred

deleteActivity

public static void deleteActivity(SocialActivity activity)
                           throws SystemException

Removes the stored activity and its mirror activity from the database.

Parameters:

activity - the activity to be removed

Throws:

SystemException - if a system exception occurred

deleteUserActivities

public static void deleteUserActivities(long userId)
                                 throws SystemException

Removes the user's stored activities from the database.

This method removes all activities where the user is either the actor or the receiver.

Parameters:

userId - the primary key of the user

Throws:

SystemException - if a system exception occurred

getActivities

public static List<SocialActivity> getActivities(long classNameId,
                                                 int start,
                                                 int end)
                                          throws 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:

SystemException - if a system exception occurred

getActivities

public static List<SocialActivity> getActivities(long mirrorActivityId,
                                                 long classNameId,
                                                 long classPK,
                                                 int start,
                                                 int end)
                                          throws 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:

SystemException - if a system exception occurred

getActivities

public static List<SocialActivity> getActivities(long mirrorActivityId,
                                                 String className,
                                                 long classPK,
                                                 int start,
                                                 int end)
                                          throws 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:

SystemException - if a system exception occurred

getActivities

public static List<SocialActivity> getActivities(String className,
                                                 int start,
                                                 int end)
                                          throws 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:

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,
                                     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(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

getGroupActivities

public static List<SocialActivity> getGroupActivities(long groupId,
                                                      int start,
                                                      int end)
                                               throws 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:

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 List<SocialActivity> getGroupUsersActivities(long groupId,
                                                           int start,
                                                           int end)
                                                    throws 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:

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 List<SocialActivity> getOrganizationActivities(long organizationId,
                                                             int start,
                                                             int end)
                                                      throws 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:

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 List<SocialActivity> getOrganizationUsersActivities(long organizationId,
                                                                  int start,
                                                                  int end)
                                                           throws 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:

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 List<SocialActivity> getRelationActivities(long userId,
                                                         int start,
                                                         int end)
                                                  throws 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:

SystemException - if a system exception occurred

getRelationActivities

public static List<SocialActivity> getRelationActivities(long userId,
                                                         int type,
                                                         int start,
                                                         int end)
                                                  throws 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:

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 List<SocialActivity> getUserActivities(long userId,
                                                     int start,
                                                     int end)
                                              throws 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:

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 List<SocialActivity> getUserGroupsActivities(long userId,
                                                           int start,
                                                           int end)
                                                    throws 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:

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 List<SocialActivity> getUserGroupsAndOrganizationsActivities(long userId,
                                                                           int start,
                                                                           int end)
                                                                    throws 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:

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 List<SocialActivity> getUserOrganizationsActivities(long userId,
                                                                  int start,
                                                                  int end)
                                                           throws 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:

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 SocialActivityLocalService getService()

setService

public void setService(SocialActivityLocalService service)

Deprecated.