Liferay 6.2-ce-ga5

com.liferay.portlet.social.service
Class SocialActivityLocalServiceWrapper

java.lang.Object
  extended by com.liferay.portlet.social.service.SocialActivityLocalServiceWrapper
All Implemented Interfaces:
BaseLocalService, PersistedModelLocalService, ServiceWrapper<SocialActivityLocalService>, SocialActivityLocalService

@ProviderType
public class SocialActivityLocalServiceWrapper
extends Object
implements SocialActivityLocalService, ServiceWrapper<SocialActivityLocalService>

Provides a wrapper for SocialActivityLocalService.

See Also:
SocialActivityLocalService

Constructor Summary
SocialActivityLocalServiceWrapper(SocialActivityLocalService socialActivityLocalService)
           
 
Method Summary
 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.
 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.
 void addActivity(SocialActivity activity, SocialActivity mirrorActivity)
           
 SocialActivity addSocialActivity(SocialActivity socialActivity)
          Adds the social activity to the database.
 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.
 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.
 SocialActivity createSocialActivity(long activityId)
          Creates a new social activity with the primary key.
 void deleteActivities(AssetEntry assetEntry)
          Removes stored activities for the asset.
 void deleteActivities(long groupId)
           
 void deleteActivities(String className, long classPK)
          Removes stored activities for the asset identified by the class name and class primary key.
 void deleteActivity(long activityId)
          Removes the stored activity from the database.
 void deleteActivity(SocialActivity activity)
          Removes the stored activity and its mirror activity from the database.
 SocialActivity deleteSocialActivity(long activityId)
          Deletes the social activity with the primary key from the database.
 SocialActivity deleteSocialActivity(SocialActivity socialActivity)
          Deletes the social activity from the database.
 void deleteUserActivities(long userId)
          Removes the user's stored activities from the database.
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 SocialActivity fetchFirstActivity(String className, long classPK, int type)
           
 SocialActivity fetchSocialActivity(long activityId)
           
 List<SocialActivity> getActivities(long classNameId, int start, int end)
          Returns a range of all the activities done on assets identified by the class name ID.
 List<SocialActivity> getActivities(long mirrorActivityId, long classNameId, long classPK, int start, int end)
          Returns a range of all the activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.
 List<SocialActivity> getActivities(long mirrorActivityId, String className, long classPK, int start, int end)
          Returns a range of all the activities done on the asset identified by the class name and the class primary key that are mirrors of the activity identified by the mirror activity ID.
 List<SocialActivity> getActivities(String className, int start, int end)
          Returns a range of all the activities done on assets identified by the class name.
 int getActivitiesCount(long classNameId)
          Returns the number of activities done on assets identified by the class name ID.
 int getActivitiesCount(long mirrorActivityId, long classNameId, long classPK)
          Returns the number of activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.
 int getActivitiesCount(long mirrorActivityId, String className, long classPK)
          Returns the number of activities done on the asset identified by the class name and class primary key that are mirrors of the activity identified by the mirror activity ID.
 int getActivitiesCount(String className)
          Returns the number of activities done on assets identified by class name.
 SocialActivity getActivity(long activityId)
          Returns the activity identified by its primary key.
 List<SocialActivity> getActivitySetActivities(long activitySetId, int start, int end)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<SocialActivity> getGroupActivities(long groupId, int start, int end)
          Returns a range of all the activities done in the group.
 int getGroupActivitiesCount(long groupId)
          Returns the number of activities done in the group.
 List<SocialActivity> getGroupUsersActivities(long groupId, int start, int end)
          Returns a range of activities done by users that are members of the group.
 int getGroupUsersActivitiesCount(long groupId)
          Returns the number of activities done by users that are members of the group.
 SocialActivity getMirrorActivity(long mirrorActivityId)
          Returns the activity that has the mirror activity.
 List<SocialActivity> getOrganizationActivities(long organizationId, int start, int end)
          Returns a range of all the activities done in the organization.
 int getOrganizationActivitiesCount(long organizationId)
          Returns the number of activities done in the organization.
 List<SocialActivity> getOrganizationUsersActivities(long organizationId, int start, int end)
          Returns a range of all the activities done by users of the organization.
 int getOrganizationUsersActivitiesCount(long organizationId)
          Returns the number of activities done by users of the organization.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<SocialActivity> getRelationActivities(long userId, int start, int end)
          Returns a range of all the activities done by users in a relationship with the user identified by the user ID.
 List<SocialActivity> getRelationActivities(long userId, int type, int start, int end)
          Returns a range of all the activities done by users in a relationship of type type with the user identified by userId.
 int getRelationActivitiesCount(long userId)
          Returns the number of activities done by users in a relationship with the user identified by userId.
 int getRelationActivitiesCount(long userId, int type)
          Returns the number of activities done by users in a relationship of type type with the user identified by userId.
 List<SocialActivity> getSocialActivities(int start, int end)
          Returns a range of all the social activities.
 int getSocialActivitiesCount()
          Returns the number of social activities.
 SocialActivity getSocialActivity(long activityId)
          Returns the social activity with the primary key.
 List<SocialActivity> getUserActivities(long userId, int start, int end)
          Returns a range of all the activities done by the user.
 int getUserActivitiesCount(long userId)
          Returns the number of activities done by the user.
 List<SocialActivity> getUserGroupsActivities(long userId, int start, int end)
          Returns a range of all the activities done in the user's groups.
 int getUserGroupsActivitiesCount(long userId)
          Returns the number of activities done in user's groups.
 List<SocialActivity> getUserGroupsAndOrganizationsActivities(long userId, int start, int end)
          Returns a range of all the activities done in the user's groups and organizations.
 int getUserGroupsAndOrganizationsActivitiesCount(long userId)
          Returns the number of activities done in user's groups and organizations.
 List<SocialActivity> getUserOrganizationsActivities(long userId, int start, int end)
          Returns a range of all activities done in the user's organizations.
 int getUserOrganizationsActivitiesCount(long userId)
          Returns the number of activities done in the user's organizations.
 SocialActivityLocalService getWrappedService()
           
 SocialActivityLocalService getWrappedSocialActivityLocalService()
          Deprecated. As of 6.1.0, replaced by getWrappedService()
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setWrappedService(SocialActivityLocalService socialActivityLocalService)
           
 void setWrappedSocialActivityLocalService(SocialActivityLocalService socialActivityLocalService)
          Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.social.service.SocialActivityLocalService)
 SocialActivity updateSocialActivity(SocialActivity socialActivity)
          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

SocialActivityLocalServiceWrapper

public SocialActivityLocalServiceWrapper(SocialActivityLocalService socialActivityLocalService)
Method Detail

addSocialActivity

public SocialActivity addSocialActivity(SocialActivity socialActivity)
                                 throws SystemException
Adds the social activity to the database. Also notifies the appropriate model listeners.

Specified by:
addSocialActivity in interface SocialActivityLocalService
Parameters:
socialActivity - the social activity
Returns:
the social activity that was added
Throws:
SystemException - if a system exception occurred

createSocialActivity

public SocialActivity createSocialActivity(long activityId)
Creates a new social activity with the primary key. Does not add the social activity to the database.

Specified by:
createSocialActivity in interface SocialActivityLocalService
Parameters:
activityId - the primary key for the new social activity
Returns:
the new social activity

deleteSocialActivity

public SocialActivity deleteSocialActivity(long activityId)
                                    throws PortalException,
                                           SystemException
Deletes the social activity with the primary key from the database. Also notifies the appropriate model listeners.

Specified by:
deleteSocialActivity in interface SocialActivityLocalService
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 SocialActivity deleteSocialActivity(SocialActivity socialActivity)
                                    throws SystemException
Deletes the social activity from the database. Also notifies the appropriate model listeners.

Specified by:
deleteSocialActivity in interface SocialActivityLocalService
Parameters:
socialActivity - the social activity
Returns:
the social activity that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

public DynamicQuery dynamicQuery()
Specified by:
dynamicQuery in interface SocialActivityLocalService

dynamicQuery

public List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Specified by:
dynamicQuery in interface SocialActivityLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialActivityModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface SocialActivityLocalService
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 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialActivityModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
dynamicQuery in interface SocialActivityLocalService
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 long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Specified by:
dynamicQueryCount in interface SocialActivityLocalService
Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Specified by:
dynamicQueryCount in interface SocialActivityLocalService
Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchSocialActivity

public SocialActivity fetchSocialActivity(long activityId)
                                   throws SystemException
Specified by:
fetchSocialActivity in interface SocialActivityLocalService
Throws:
SystemException

getSocialActivity

public SocialActivity getSocialActivity(long activityId)
                                 throws PortalException,
                                        SystemException
Returns the social activity with the primary key.

Specified by:
getSocialActivity in interface SocialActivityLocalService
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 PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Specified by:
getPersistedModel in interface SocialActivityLocalService
Throws:
PortalException
SystemException

getSocialActivities

public 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from SocialActivityModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Specified by:
getSocialActivities in interface SocialActivityLocalService
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 int getSocialActivitiesCount()
                             throws SystemException
Returns the number of social activities.

Specified by:
getSocialActivitiesCount in interface SocialActivityLocalService
Returns:
the number of social activities
Throws:
SystemException - if a system exception occurred

updateSocialActivity

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

Specified by:
updateSocialActivity in interface SocialActivityLocalService
Parameters:
socialActivity - the social activity
Returns:
the social activity that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface SocialActivityLocalService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface SocialActivityLocalService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addActivity

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

Specified by:
addActivity in interface SocialActivityLocalService
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 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.

Specified by:
addActivity in interface SocialActivityLocalService
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 void addActivity(SocialActivity activity,
                        SocialActivity mirrorActivity)
                 throws PortalException,
                        SystemException
Specified by:
addActivity in interface SocialActivityLocalService
Throws:
PortalException
SystemException

addUniqueActivity

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

Specified by:
addUniqueActivity in interface SocialActivityLocalService
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 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)

Specified by:
addUniqueActivity in interface SocialActivityLocalService
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 void deleteActivities(AssetEntry assetEntry)
                      throws PortalException,
                             SystemException
Removes stored activities for the asset.

Specified by:
deleteActivities in interface SocialActivityLocalService
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 void deleteActivities(long groupId)
                      throws SystemException
Specified by:
deleteActivities in interface SocialActivityLocalService
Throws:
SystemException

deleteActivities

public void deleteActivities(String className,
                             long classPK)
                      throws PortalException,
                             SystemException
Removes stored activities for the asset identified by the class name and class primary key.

Specified by:
deleteActivities in interface SocialActivityLocalService
Parameters:
className - the target asset's class name
classPK - the primary key of the target asset
Throws:
PortalException - if the user's activity counters could not be deleted
SystemException - if a system exception occurred

deleteActivity

public void deleteActivity(long activityId)
                    throws PortalException,
                           SystemException
Removes the stored activity from the database.

Specified by:
deleteActivity in interface SocialActivityLocalService
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 void deleteActivity(SocialActivity activity)
                    throws PortalException,
                           SystemException
Removes the stored activity and its mirror activity from the database.

Specified by:
deleteActivity in interface SocialActivityLocalService
Parameters:
activity - the activity to be removed
Throws:
PortalException - if the user's activity counters could not be deleted or if a portal exception occurred
SystemException - if a system exception occurred

deleteUserActivities

public void deleteUserActivities(long userId)
                          throws PortalException,
                                 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.

Specified by:
deleteUserActivities in interface SocialActivityLocalService
Parameters:
userId - the primary key of the user
Throws:
PortalException - if the user's activity counters could not be deleted
SystemException - if a system exception occurred

fetchFirstActivity

public SocialActivity fetchFirstActivity(String className,
                                         long classPK,
                                         int type)
                                  throws SystemException
Specified by:
fetchFirstActivity in interface SocialActivityLocalService
Throws:
SystemException

getActivities

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

Specified by:
getActivities in interface SocialActivityLocalService
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 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.

Specified by:
getActivities in interface SocialActivityLocalService
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 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.

Specified by:
getActivities in interface SocialActivityLocalService
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 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.

Specified by:
getActivities in interface SocialActivityLocalService
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 int getActivitiesCount(long classNameId)
                       throws SystemException
Returns the number of activities done on assets identified by the class name ID.

Specified by:
getActivitiesCount in interface SocialActivityLocalService
Parameters:
classNameId - the target asset's class name ID
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getActivitiesCount

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

Specified by:
getActivitiesCount in interface SocialActivityLocalService
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 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.

Specified by:
getActivitiesCount in interface SocialActivityLocalService
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 int getActivitiesCount(String className)
                       throws SystemException
Returns the number of activities done on assets identified by class name.

Specified by:
getActivitiesCount in interface SocialActivityLocalService
Parameters:
className - the target asset's class name
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getActivity

public SocialActivity getActivity(long activityId)
                           throws PortalException,
                                  SystemException
Returns the activity identified by its primary key.

Specified by:
getActivity in interface SocialActivityLocalService
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 List<SocialActivity> getActivitySetActivities(long activitySetId,
                                                     int start,
                                                     int end)
                                              throws SystemException
Specified by:
getActivitySetActivities in interface SocialActivityLocalService
Throws:
SystemException

getGroupActivities

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

Specified by:
getGroupActivities in interface SocialActivityLocalService
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 int getGroupActivitiesCount(long groupId)
                            throws SystemException
Returns the number of activities done in the group.

This method only counts activities without mirrors.

Specified by:
getGroupActivitiesCount in interface SocialActivityLocalService
Parameters:
groupId - the primary key of the group
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getGroupUsersActivities

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

Specified by:
getGroupUsersActivities in interface SocialActivityLocalService
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 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.

Specified by:
getGroupUsersActivitiesCount in interface SocialActivityLocalService
Parameters:
groupId - the primary key of the group
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getMirrorActivity

public SocialActivity getMirrorActivity(long mirrorActivityId)
                                 throws PortalException,
                                        SystemException
Returns the activity that has the mirror activity.

Specified by:
getMirrorActivity in interface SocialActivityLocalService
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 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.

Specified by:
getOrganizationActivities in interface SocialActivityLocalService
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 int getOrganizationActivitiesCount(long organizationId)
                                   throws SystemException
Returns the number of activities done in the organization. This method only counts activities without mirrors.

Specified by:
getOrganizationActivitiesCount in interface SocialActivityLocalService
Parameters:
organizationId - the primary key of the organization
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getOrganizationUsersActivities

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

Specified by:
getOrganizationUsersActivities in interface SocialActivityLocalService
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 int getOrganizationUsersActivitiesCount(long organizationId)
                                        throws SystemException
Returns the number of activities done by users of the organization. This method only counts activities without mirrors.

Specified by:
getOrganizationUsersActivitiesCount in interface SocialActivityLocalService
Parameters:
organizationId - the primary key of the organization
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getRelationActivities

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

Specified by:
getRelationActivities in interface SocialActivityLocalService
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 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.

Specified by:
getRelationActivities in interface SocialActivityLocalService
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 int getRelationActivitiesCount(long userId)
                               throws SystemException
Returns the number of activities done by users in a relationship with the user identified by userId.

Specified by:
getRelationActivitiesCount in interface SocialActivityLocalService
Parameters:
userId - the primary key of the user
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getRelationActivitiesCount

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

Specified by:
getRelationActivitiesCount in interface SocialActivityLocalService
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 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.

Specified by:
getUserActivities in interface SocialActivityLocalService
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 int getUserActivitiesCount(long userId)
                           throws SystemException
Returns the number of activities done by the user.

Specified by:
getUserActivitiesCount in interface SocialActivityLocalService
Parameters:
userId - the primary key of the user
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getUserGroupsActivities

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

Specified by:
getUserGroupsActivities in interface SocialActivityLocalService
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 int getUserGroupsActivitiesCount(long userId)
                                 throws SystemException
Returns the number of activities done in user's groups. This method only counts activities without mirrors.

Specified by:
getUserGroupsActivitiesCount in interface SocialActivityLocalService
Parameters:
userId - the primary key of the user
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getUserGroupsAndOrganizationsActivities

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

Specified by:
getUserGroupsAndOrganizationsActivities in interface SocialActivityLocalService
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 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.

Specified by:
getUserGroupsAndOrganizationsActivitiesCount in interface SocialActivityLocalService
Parameters:
userId - the primary key of the user
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getUserOrganizationsActivities

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

Specified by:
getUserOrganizationsActivities in interface SocialActivityLocalService
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 int getUserOrganizationsActivitiesCount(long userId)
                                        throws SystemException
Returns the number of activities done in the user's organizations. This method only counts activities without mirrors.

Specified by:
getUserOrganizationsActivitiesCount in interface SocialActivityLocalService
Parameters:
userId - the primary key of the user
Returns:
the number of matching activities
Throws:
SystemException - if a system exception occurred

getWrappedSocialActivityLocalService

public SocialActivityLocalService getWrappedSocialActivityLocalService()
Deprecated. As of 6.1.0, replaced by getWrappedService()


setWrappedSocialActivityLocalService

public void setWrappedSocialActivityLocalService(SocialActivityLocalService socialActivityLocalService)
Deprecated. As of 6.1.0, replaced by setWrappedService(com.liferay.portlet.social.service.SocialActivityLocalService)


getWrappedService

public SocialActivityLocalService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<SocialActivityLocalService>

setWrappedService

public void setWrappedService(SocialActivityLocalService socialActivityLocalService)
Specified by:
setWrappedService in interface ServiceWrapper<SocialActivityLocalService>

Liferay 6.2-ce-ga5