|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.BaseLocalServiceImpl com.liferay.portlet.social.service.base.SocialActivityLocalServiceBaseImpl com.liferay.portlet.social.service.impl.SocialActivityLocalServiceImpl
public class SocialActivityLocalServiceImpl
The social activity local service. This service provides the means to record and list social activities in groups and organizations.
Social activities are identified by their type and the type of asset they are done on. Each activity records the exact time of the action as well as human readable information needed for activity feeds.
Most of the get- methods in this service order activities in descending order by their execution times, so the most recent activities are listed first.
Field Summary |
---|
Constructor Summary | |
---|---|
SocialActivityLocalServiceImpl()
|
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)
|
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. |
void |
deleteActivities(AssetEntry assetEntry)
Removes stored activities for the asset identified by the class name ID and class primary key. |
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. |
void |
deleteUserActivities(long userId)
Removes the user's stored activities from the database. |
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> |
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. |
List<SocialActivity> |
getRelationActivities(long userId,
int start,
int end)
Returns a range of all the activities done by users in a relationship with the user identified by the user ID. |
List<SocialActivity> |
getRelationActivities(long userId,
int type,
int start,
int end)
Returns a range of all the activities done by users in a relationship of type type with the user identified by userId . |
int |
getRelationActivitiesCount(long userId)
Returns the number of activities done by users in a relationship with the user identified by userId. |
int |
getRelationActivitiesCount(long userId,
int type)
Returns the number of activities done by users in a relationship of type type with the user identified by userId . |
List<SocialActivity> |
getUserActivities(long userId,
int start,
int end)
Returns a range of all the activities done by the user. |
int |
getUserActivitiesCount(long userId)
Returns the number of activities done by the user. |
List<SocialActivity> |
getUserGroupsActivities(long userId,
int start,
int end)
Returns a range of all the activities done in the user's groups. |
int |
getUserGroupsActivitiesCount(long userId)
Returns the number of activities done in user's groups. |
List<SocialActivity> |
getUserGroupsAndOrganizationsActivities(long userId,
int start,
int end)
Returns a range of all the activities done in the user's groups and organizations. |
int |
getUserGroupsAndOrganizationsActivitiesCount(long userId)
Returns the number of activities done in user's groups and organizations. |
List<SocialActivity> |
getUserOrganizationsActivities(long userId,
int start,
int end)
Returns a range of all activities done in the user's organizations. |
int |
getUserOrganizationsActivitiesCount(long userId)
Returns the number of activities done in the user's organizations. |
Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl |
---|
getClassLoader |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SocialActivityLocalServiceImpl()
Method Detail |
---|
public void addActivity(long userId, long groupId, Date createDate, String className, long classPK, int type, String extraData, long receiverUserId) throws PortalException, SystemException
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.
userId
- the primary key of the acting usergroupId
- the primary key of the groupcreateDate
- the activity's dateclassName
- the target asset's class nameclassPK
- the primary key of the target assettype
- the activity's typeextraData
- any extra data regarding the activityreceiverUserId
- the primary key of the receiving user
PortalException
- if the user or group could not be found
SystemException
- if a system exception occurredpublic void addActivity(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) throws PortalException, SystemException
userId
- the primary key of the acting usergroupId
- the primary key of the groupclassName
- the target asset's class nameclassPK
- the primary key of the target assettype
- the activity's typeextraData
- any extra data regarding the activityreceiverUserId
- the primary key of the receiving user
PortalException
- if the user or group could not be found
SystemException
- if a system exception occurred@Async public void addActivity(SocialActivity activity, SocialActivity mirrorActivity) throws PortalException, SystemException
PortalException
SystemException
public void addUniqueActivity(long userId, long groupId, Date createDate, String className, long classPK, int type, String extraData, long receiverUserId) throws PortalException, SystemException
For the main functionality see addActivity(long, long, Date,
String, long, int, String, long)
userId
- the primary key of the acting usergroupId
- the primary key of the groupcreateDate
- the activity's dateclassName
- the target asset's class nameclassPK
- the primary key of the target assettype
- the activity's typeextraData
- any extra data regarding the activityreceiverUserId
- the primary key of the receiving user
PortalException
- if the user or group could not be found
SystemException
- if a system exception occurredpublic void addUniqueActivity(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) throws PortalException, SystemException
For the main functionality see addActivity(long, long, Date,
String, long, int, String, long)
userId
- the primary key of the acting usergroupId
- the primary key of the groupclassName
- the target asset's class nameclassPK
- the primary key of the target assettype
- the activity's typeextraData
- any extra data regarding the activityreceiverUserId
- the primary key of the receiving user
PortalException
- if the user or group could not be found
SystemException
- if a system exception occurredpublic void deleteActivities(AssetEntry assetEntry) throws PortalException, SystemException
assetEntry
- the asset from which to remove stored activities
PortalException
- if a portal exception occurred
SystemException
- if a system exception occurredpublic void deleteActivities(String className, long classPK) throws SystemException
className
- the target asset's class nameclassPK
- the primary key of the target asset
SystemException
- if a system exception occurredpublic void deleteActivity(long activityId) throws PortalException, SystemException
activityId
- the primary key of the stored activity
PortalException
- if the activity could not be found
SystemException
- if a system exception occurredpublic void deleteActivity(SocialActivity activity) throws SystemException
activity
- the activity to be removed
SystemException
- if a system exception occurredpublic void deleteUserActivities(long userId) throws SystemException
This method removes all activities where the user is either the actor or the receiver.
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic List<SocialActivity> getActivities(long classNameId, int start, int end) throws SystemException
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.
classNameId
- the target asset's class name IDstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic List<SocialActivity> getActivities(long mirrorActivityId, long classNameId, long classPK, int start, int end) throws SystemException
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.
mirrorActivityId
- the primary key of the mirror activityclassNameId
- the target asset's class name IDclassPK
- the primary key of the target assetstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic List<SocialActivity> getActivities(long mirrorActivityId, String className, long classPK, int start, int end) throws SystemException
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.
mirrorActivityId
- the primary key of the mirror activityclassName
- the target asset's class nameclassPK
- the primary key of the target assetstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic List<SocialActivity> getActivities(String className, int start, int end) throws SystemException
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.
className
- the target asset's class namestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getActivitiesCount(long classNameId) throws SystemException
classNameId
- the target asset's class name ID
SystemException
- if a system exception occurredpublic int getActivitiesCount(long mirrorActivityId, long classNameId, long classPK) throws SystemException
mirrorActivityId
- the primary key of the mirror activityclassNameId
- the target asset's class name IDclassPK
- the primary key of the target asset
SystemException
- if a system exception occurredpublic int getActivitiesCount(long mirrorActivityId, String className, long classPK) throws SystemException
mirrorActivityId
- the primary key of the mirror activityclassName
- the target asset's class nameclassPK
- the primary key of the target asset
SystemException
- if a system exception occurredpublic int getActivitiesCount(String className) throws SystemException
className
- the target asset's class name
SystemException
- if a system exception occurredpublic SocialActivity getActivity(long activityId) throws PortalException, SystemException
activityId
- the primary key of the activity
PortalException
- if the activity could not be found
SystemException
- if a system exception occurredpublic List<SocialActivity> getGroupActivities(long groupId, int start, int end) throws SystemException
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.
groupId
- the primary key of the groupstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getGroupActivitiesCount(long groupId) throws SystemException
This method only counts activities without mirrors.
groupId
- the primary key of the group
SystemException
- if a system exception occurredpublic List<SocialActivity> getGroupUsersActivities(long groupId, int start, int end) throws SystemException
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.
groupId
- the primary key of the groupstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getGroupUsersActivitiesCount(long groupId) throws SystemException
This method only counts activities without mirrors.
groupId
- the primary key of the group
SystemException
- if a system exception occurredpublic SocialActivity getMirrorActivity(long mirrorActivityId) throws PortalException, SystemException
mirrorActivityId
- the primary key of the mirror activity
PortalException
- if the mirror activity could not be found
SystemException
- if a system exception occurredpublic List<SocialActivity> getOrganizationActivities(long organizationId, int start, int end) throws SystemException
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.
organizationId
- the primary key of the organizationstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getOrganizationActivitiesCount(long organizationId) throws SystemException
organizationId
- the primary key of the organization
SystemException
- if a system exception occurredpublic List<SocialActivity> getOrganizationUsersActivities(long organizationId, int start, int end) throws SystemException
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.
organizationId
- the primary key of the organizationstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getOrganizationUsersActivitiesCount(long organizationId) throws SystemException
organizationId
- the primary key of the organization
SystemException
- if a system exception occurredpublic List<SocialActivity> getRelationActivities(long userId, int start, int end) throws SystemException
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.
userId
- the primary key of the userstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic List<SocialActivity> getRelationActivities(long userId, int type, int start, int end) throws SystemException
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.
userId
- the primary key of the usertype
- the relationship typestart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getRelationActivitiesCount(long userId) throws SystemException
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic int getRelationActivitiesCount(long userId, int type) throws SystemException
type
with the user identified by userId
. This
method only counts activities without mirrors.
userId
- the primary key of the usertype
- the relationship type
SystemException
- if a system exception occurredpublic List<SocialActivity> getUserActivities(long userId, int start, int end) throws SystemException
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.
userId
- the primary key of the userstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getUserActivitiesCount(long userId) throws SystemException
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic List<SocialActivity> getUserGroupsActivities(long userId, int start, int end) throws SystemException
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.
userId
- the primary key of the userstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getUserGroupsActivitiesCount(long userId) throws SystemException
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic List<SocialActivity> getUserGroupsAndOrganizationsActivities(long userId, int start, int end) throws SystemException
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.
userId
- the primary key of the userstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getUserGroupsAndOrganizationsActivitiesCount(long userId) throws SystemException
userId
- the primary key of the user
SystemException
- if a system exception occurredpublic List<SocialActivity> getUserOrganizationsActivities(long userId, int start, int end) throws SystemException
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.
userId
- the primary key of the userstart
- the lower bound of the range of resultsend
- the upper bound of the range of results (not inclusive)
SystemException
- if a system exception occurredpublic int getUserOrganizationsActivitiesCount(long userId) throws SystemException
userId
- the primary key of the user
SystemException
- if a system exception occurred
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |