public class SocialActivityLocalServiceImpl extends SocialActivityLocalServiceBaseImpl
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.
assetEntryFinder, assetEntryLocalService, assetEntryPersistence, classNameLocalService, classNamePersistence, counterLocalService, groupFinder, groupLocalService, groupPersistence, layoutFinder, layoutLocalService, layoutPersistence, persistedModelLocalServiceRegistry, socialActivityCounterFinder, socialActivityCounterLocalService, socialActivityCounterPersistence, socialActivityFinder, socialActivityInterpreterLocalService, socialActivityLimitLocalService, socialActivityLimitPersistence, socialActivityLocalService, socialActivityPersistence, socialActivitySetFinder, socialActivitySetLocalService, socialActivitySetPersistence, socialActivitySettingLocalService, socialActivitySettingPersistence, userFinder, userLocalService, userPersistence
Constructor and Description |
---|
SocialActivityLocalServiceImpl() |
Modifier and Type | Method and Description |
---|---|
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(com.liferay.social.kernel.model.SocialActivity activity,
com.liferay.social.kernel.model.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(com.liferay.asset.kernel.model.AssetEntry assetEntry)
Removes stored activities for the asset.
|
void |
deleteActivities(long groupId) |
protected void |
deleteActivities(long classNameId,
long classPK) |
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(com.liferay.social.kernel.model.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.
|
com.liferay.social.kernel.model.SocialActivity |
fetchFirstActivity(String className,
long classPK,
int type) |
List<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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 userId,
long groupId,
Date createDate,
String className,
long classPK,
int type,
long receiverUserId) |
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.
|
com.liferay.social.kernel.model.SocialActivity |
getActivity(long activityId)
Returns the activity identified by its primary key.
|
List<com.liferay.social.kernel.model.SocialActivity> |
getActivitySetActivities(long activitySetId,
int start,
int end) |
List<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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.
|
com.liferay.social.kernel.model.SocialActivity |
getMirrorActivity(long mirrorActivityId)
Returns the activity that has the mirror activity.
|
List<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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<com.liferay.social.kernel.model.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.
|
protected boolean |
isLogActivity(com.liferay.social.kernel.model.SocialActivity activity) |
addSocialActivity, afterPropertiesSet, createSocialActivity, deletePersistedModel, deleteSocialActivity, deleteSocialActivity, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchSocialActivity, getActionableDynamicQuery, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getClassNameLocalService, getClassNamePersistence, getCounterLocalService, getGroupFinder, getGroupLocalService, getGroupPersistence, getIndexableActionableDynamicQuery, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getModelClass, getModelClassName, getOSGiServiceIdentifier, getPersistedModel, getSocialActivities, getSocialActivitiesCount, getSocialActivity, getSocialActivityCounterFinder, getSocialActivityCounterLocalService, getSocialActivityCounterPersistence, getSocialActivityFinder, getSocialActivityInterpreterLocalService, getSocialActivityLimitLocalService, getSocialActivityLimitPersistence, getSocialActivityLocalService, getSocialActivityPersistence, getSocialActivitySetFinder, getSocialActivitySetLocalService, getSocialActivitySetPersistence, getSocialActivitySettingLocalService, getSocialActivitySettingPersistence, getUserFinder, getUserLocalService, getUserPersistence, initActionableDynamicQuery, runSQL, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setClassNameLocalService, setClassNamePersistence, setCounterLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setSocialActivityCounterFinder, setSocialActivityCounterLocalService, setSocialActivityCounterPersistence, setSocialActivityFinder, setSocialActivityInterpreterLocalService, setSocialActivityLimitLocalService, setSocialActivityLimitPersistence, setSocialActivityLocalService, setSocialActivityPersistence, setSocialActivitySetFinder, setSocialActivitySetLocalService, setSocialActivitySetPersistence, setSocialActivitySettingLocalService, setSocialActivitySettingPersistence, setUserFinder, setUserLocalService, setUserPersistence, updateSocialActivity
public void addActivity(long userId, long groupId, Date createDate, String className, long classPK, int type, String extraData, long receiverUserId) throws com.liferay.portal.kernel.exception.PortalException
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 usercom.liferay.portal.kernel.exception.PortalException
public void addActivity(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) throws com.liferay.portal.kernel.exception.PortalException
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 usercom.liferay.portal.kernel.exception.PortalException
@Async public void addActivity(com.liferay.social.kernel.model.SocialActivity activity, com.liferay.social.kernel.model.SocialActivity mirrorActivity) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public void addUniqueActivity(long userId, long groupId, Date createDate, String className, long classPK, int type, String extraData, long receiverUserId) throws com.liferay.portal.kernel.exception.PortalException
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 usercom.liferay.portal.kernel.exception.PortalException
public void addUniqueActivity(long userId, long groupId, String className, long classPK, int type, String extraData, long receiverUserId) throws com.liferay.portal.kernel.exception.PortalException
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 usercom.liferay.portal.kernel.exception.PortalException
public void deleteActivities(com.liferay.asset.kernel.model.AssetEntry assetEntry) throws com.liferay.portal.kernel.exception.PortalException
assetEntry
- the asset from which to remove stored activitiescom.liferay.portal.kernel.exception.PortalException
public void deleteActivities(long groupId)
public void deleteActivities(String className, long classPK) throws com.liferay.portal.kernel.exception.PortalException
className
- the target asset's class nameclassPK
- the primary key of the target assetcom.liferay.portal.kernel.exception.PortalException
public void deleteActivity(long activityId) throws com.liferay.portal.kernel.exception.PortalException
activityId
- the primary key of the stored activitycom.liferay.portal.kernel.exception.PortalException
public void deleteActivity(com.liferay.social.kernel.model.SocialActivity activity) throws com.liferay.portal.kernel.exception.PortalException
activity
- the activity to be removedcom.liferay.portal.kernel.exception.PortalException
public void deleteUserActivities(long userId) throws com.liferay.portal.kernel.exception.PortalException
This method removes all activities where the user is either the actor or the receiver.
userId
- the primary key of the usercom.liferay.portal.kernel.exception.PortalException
public com.liferay.social.kernel.model.SocialActivity fetchFirstActivity(String className, long classPK, int type)
public List<com.liferay.social.kernel.model.SocialActivity> getActivities(long classNameId, int start, int end)
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)public List<com.liferay.social.kernel.model.SocialActivity> getActivities(long mirrorActivityId, long classNameId, long classPK, int start, int end)
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)public List<com.liferay.social.kernel.model.SocialActivity> getActivities(long mirrorActivityId, String className, long classPK, int start, int end)
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)public List<com.liferay.social.kernel.model.SocialActivity> getActivities(String className, int start, int end)
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)public int getActivitiesCount(long classNameId)
classNameId
- the target asset's class name IDpublic int getActivitiesCount(long userId, long groupId, Date createDate, String className, long classPK, int type, long receiverUserId)
public int getActivitiesCount(long mirrorActivityId, long classNameId, long classPK)
mirrorActivityId
- the primary key of the mirror activityclassNameId
- the target asset's class name IDclassPK
- the primary key of the target assetpublic int getActivitiesCount(long mirrorActivityId, String className, long classPK)
mirrorActivityId
- the primary key of the mirror activityclassName
- the target asset's class nameclassPK
- the primary key of the target assetpublic int getActivitiesCount(String className)
className
- the target asset's class namepublic com.liferay.social.kernel.model.SocialActivity getActivity(long activityId) throws com.liferay.portal.kernel.exception.PortalException
activityId
- the primary key of the activitycom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.social.kernel.model.SocialActivity> getActivitySetActivities(long activitySetId, int start, int end)
public List<com.liferay.social.kernel.model.SocialActivity> getGroupActivities(long groupId, int start, int end)
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)public int getGroupActivitiesCount(long groupId)
This method only counts activities without mirrors.
groupId
- the primary key of the grouppublic List<com.liferay.social.kernel.model.SocialActivity> getGroupUsersActivities(long groupId, int start, int end)
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)public int getGroupUsersActivitiesCount(long groupId)
This method only counts activities without mirrors.
groupId
- the primary key of the grouppublic com.liferay.social.kernel.model.SocialActivity getMirrorActivity(long mirrorActivityId) throws com.liferay.portal.kernel.exception.PortalException
mirrorActivityId
- the primary key of the mirror activitycom.liferay.portal.kernel.exception.PortalException
public List<com.liferay.social.kernel.model.SocialActivity> getOrganizationActivities(long organizationId, int start, int end)
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)public int getOrganizationActivitiesCount(long organizationId)
organizationId
- the primary key of the organizationpublic List<com.liferay.social.kernel.model.SocialActivity> getOrganizationUsersActivities(long organizationId, int start, int end)
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)public int getOrganizationUsersActivitiesCount(long organizationId)
organizationId
- the primary key of the organizationpublic List<com.liferay.social.kernel.model.SocialActivity> getRelationActivities(long userId, int start, int end)
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)public List<com.liferay.social.kernel.model.SocialActivity> getRelationActivities(long userId, int type, int start, int end)
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)public int getRelationActivitiesCount(long userId)
userId
- the primary key of the userpublic int getRelationActivitiesCount(long userId, int type)
type
with the user identified by userId
. This
method only counts activities without mirrors.userId
- the primary key of the usertype
- the relationship typepublic List<com.liferay.social.kernel.model.SocialActivity> getUserActivities(long userId, int start, int end)
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)public int getUserActivitiesCount(long userId)
userId
- the primary key of the userpublic List<com.liferay.social.kernel.model.SocialActivity> getUserGroupsActivities(long userId, int start, int end)
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)public int getUserGroupsActivitiesCount(long userId)
userId
- the primary key of the userpublic List<com.liferay.social.kernel.model.SocialActivity> getUserGroupsAndOrganizationsActivities(long userId, int start, int end)
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)public int getUserGroupsAndOrganizationsActivitiesCount(long userId)
userId
- the primary key of the userpublic List<com.liferay.social.kernel.model.SocialActivity> getUserOrganizationsActivities(long userId, int start, int end)
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)public int getUserOrganizationsActivitiesCount(long userId)
userId
- the primary key of the userprotected void deleteActivities(long classNameId, long classPK) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
protected boolean isLogActivity(com.liferay.social.kernel.model.SocialActivity activity)