Class SocialActivityServiceUtil

Object
com.liferay.social.kernel.service.SocialActivityServiceUtil

public class SocialActivityServiceUtil extends Object
Provides the remote service utility for SocialActivity. This utility wraps com.liferay.portlet.social.service.impl.SocialActivityServiceImpl and is an 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:
{$generated.description}
  • Constructor Details

    • SocialActivityServiceUtil

      public SocialActivityServiceUtil()
  • Method Details

    • getActivities

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

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

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

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

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

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

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

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

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

      public static List<SocialActivity> getActivitySetActivities(long activitySetId, int start, int end) throws PortalException
      Throws:
      PortalException
    • getGroupActivities

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

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

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

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

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

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

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

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

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

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getRelationActivities

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

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

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

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

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

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

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

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

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

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

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

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

      public static SocialActivityService getService()
    • setService

      public static void setService(SocialActivityService service)