org.alfresco.service.cmr.activities
Interface ActivityService

All Superinterfaces:
ActivityPostService
All Known Implementing Classes:
ActivityServiceImpl

public interface ActivityService
extends ActivityPostService

The activity service


Method Summary
 boolean existsFeedControl(FeedControl feedControl)
          For current user, does the feed control exist ?
 java.util.List getFeedControls()
          For current user, get feed controls
 java.util.List getFeedControls(java.lang.String userId)
          For given user, get feed controls
 int getMaxFeedItems()
          Return maximum configured item entries (per feed)
 java.util.List getSiteFeedEntries(java.lang.String siteId, java.lang.String format)
          Retrieve site feed
 java.util.List getUserFeedEntries(java.lang.String userId, java.lang.String format, java.lang.String siteId)
          Retrieve user feed with optional site filter Will return activities for all users across all sites, or optionally for all users for specified site.
 java.util.List getUserFeedEntries(java.lang.String userId, java.lang.String format, java.lang.String siteId, boolean excludeThisUser, boolean excludeOtherUsers)
          Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site.
 java.util.List getUserFeedEntries(java.lang.String feedUserId, java.lang.String format, java.lang.String siteId, boolean excludeThisUser, boolean excludeOtherUsers, long minFeedId)
          Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site.
 java.util.List getUserFeedEntries(java.lang.String userId, java.lang.String format, java.lang.String siteId, boolean excludeThisUser, boolean excludeOtherUsers, java.util.Set userFilter, java.util.Set actvityFilter)
          Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site.
 java.util.List getUserFeedEntries(java.lang.String feedUserId, java.lang.String format, java.lang.String siteId, boolean excludeThisUser, boolean excludeOtherUsers, java.util.Set userFilter, java.util.Set actvityFilter, long minFeedId)
          Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site.
 void setFeedControl(FeedControl feedControl)
          For current user, set feed control (opt-out) for a site or an appTool or a site/appTool combination
 void unsetFeedControl(FeedControl feedControl)
          For current user, unset feed control
 
Methods inherited from interface org.alfresco.service.cmr.activities.ActivityPostService
postActivity, postActivity, postActivity, postActivity
 

Method Detail

getUserFeedEntries

@NotAuditable
java.util.List getUserFeedEntries(java.lang.String userId,
                                               java.lang.String format,
                                               java.lang.String siteId)
Retrieve user feed with optional site filter Will return activities for all users across all sites, or optionally for all users for specified site.

Parameters:
userId - - required
format - - required
siteId - - optional, if set then will filter by given siteId else return all sites
Returns:
list of JSON feed entries

getUserFeedEntries

@NotAuditable
java.util.List getUserFeedEntries(java.lang.String userId,
                                               java.lang.String format,
                                               java.lang.String siteId,
                                               boolean excludeThisUser,
                                               boolean excludeOtherUsers)
Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site. User filters are: - all user activities (excludeThisUser = false, excludeOtherUsers = false) - other user activities (excludeThisUser = true, excludeOtherUsers = false) - my user activities (excludeThisUser = false, excludeOtherUsers = true) note: if both excludes are true then no activities will be returned.

Parameters:
userId - - required
format - - required
siteId - - optional, if set then will filter by given siteId else return all sites
excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)
excludeOthersUsers - - if TRUE then will exclude activities for other users (hence returning this user only)
Returns:
list of JSON feed entries

getUserFeedEntries

@NotAuditable
java.util.List getUserFeedEntries(java.lang.String userId,
                                               java.lang.String format,
                                               java.lang.String siteId,
                                               boolean excludeThisUser,
                                               boolean excludeOtherUsers,
                                               java.util.Set userFilter,
                                               java.util.Set actvityFilter)
Retrieve user feed with optional site filter and optional user filters Will return activities for users across all sites, or optionally for users for specified site. User filters are: - all user activities (excludeThisUser = false, excludeOtherUsers = false) - other user activities (excludeThisUser = true, excludeOtherUsers = false) - my user activities (excludeThisUser = false, excludeOtherUsers = true) note: if both excludes are true then no activities will be returned.

Parameters:
userId - - required
format - - required
siteId - - optional, if set then will filter by given siteId else return all sites
excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)
excludeOthersUsers - - if TRUE then will exclude activities for other users (hence returning this user only)
userFilter - - if not NULL then will only return activities of users in this set
actvityFilter - - if not NULL then will only return activities that are in this set
Returns:
list of JSON feed entries

getUserFeedEntries

@NotAuditable
java.util.List getUserFeedEntries(java.lang.String feedUserId,
                                               java.lang.String format,
                                               java.lang.String siteId,
                                               boolean excludeThisUser,
                                               boolean excludeOtherUsers,
                                               long minFeedId)
Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site. User filters are: - all user activities (excludeThisUser = false, excludeOtherUsers = false) - other user activities (excludeThisUser = true, excludeOtherUsers = false) - my user activities (excludeThisUser = false, excludeOtherUsers = true) note: if both excludes are true then no activities will be returned.

Parameters:
userId - - required
format - - required
siteId - - optional, if set then will filter by given siteId else return all sites
excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)
excludeOthersUsers - - if TRUE then will exclude activities for other users (hence returning this user only)
onlyFollowing - - if TRUE then will only return activities of users this user follows
minFeedId - - inclusive from min feed DB id, if -1 then return all available
Returns:
list of JSON feed entries

getUserFeedEntries

@NotAuditable
java.util.List getUserFeedEntries(java.lang.String feedUserId,
                                               java.lang.String format,
                                               java.lang.String siteId,
                                               boolean excludeThisUser,
                                               boolean excludeOtherUsers,
                                               java.util.Set userFilter,
                                               java.util.Set actvityFilter,
                                               long minFeedId)
Retrieve user feed with optional site filter and optional user filters and optional min feed DB id Will return activities for users across all sites, or optionally for users for specified site. User filters are: - all user activities (excludeThisUser = false, excludeOtherUsers = false) - other user activities (excludeThisUser = true, excludeOtherUsers = false) - my user activities (excludeThisUser = false, excludeOtherUsers = true) note: if both excludes are true then no activities will be returned.

Parameters:
userId - - required
format - - required
siteId - - optional, if set then will filter by given siteId else return all sites
excludeThisUser - - if TRUE then will exclude activities for this user (hence returning other users only)
excludeOthersUsers - - if TRUE then will exclude activities for other users (hence returning this user only)
onlyFollowing - - if TRUE then will only return activities of users this user follows
userFilter - - if not NULL then will only return activities of users in this set
actvityFilter - - if not NULL then will only return activities that are in this set
minFeedId - - inclusive from min feed DB id, if -1 then return all available
Returns:
list of JSON feed entries

getSiteFeedEntries

@NotAuditable
java.util.List getSiteFeedEntries(java.lang.String siteId,
                                               java.lang.String format)
Retrieve site feed

Parameters:
activityType - - required
format - - required
Returns:
list of JSON feed entries

getMaxFeedItems

@NotAuditable
int getMaxFeedItems()
Return maximum configured item entries (per feed)

Returns:

setFeedControl

@NotAuditable
void setFeedControl(FeedControl feedControl)
For current user, set feed control (opt-out) for a site or an appTool or a site/appTool combination

Parameters:
feedControl - - required

getFeedControls

@NotAuditable
java.util.List getFeedControls(java.lang.String userId)
For given user, get feed controls

Parameters:
userId - - required (must match
Returns:
list of user feed controls

getFeedControls

@NotAuditable
java.util.List getFeedControls()
For current user, get feed controls

Returns:
list of user feed controls

unsetFeedControl

@NotAuditable
void unsetFeedControl(FeedControl feedControl)
For current user, unset feed control

Parameters:
feedControl - - required

existsFeedControl

@NotAuditable
boolean existsFeedControl(FeedControl feedControl)
For current user, does the feed control exist ?

Parameters:
feedControl - - required
Returns:
true, if user feed control exists


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.