Package org.alfresco.service.cmr.activities

Interface ActivityService

All Superinterfaces:
ActivityPostService
All Known Implementing Classes:
ActivityServiceImpl
@AlfrescoPublicApi public interface ActivityService extends ActivityPostService
The activity service

  • Method Details

    • getUserFeedEntries

      @NotAuditable List<String> getUserFeedEntries(String userId, 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
      siteId - - optional, if set then will filter by given siteId else return all sites
      Returns:
      list of JSON feed entries

    • getUserFeedEntries

      @NotAuditable List<String> getUserFeedEntries(String userId, 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
      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)
      excludeOtherUsers - - if TRUE then will exclude activities for other users (hence returning this user only)
      Returns:
      list of JSON feed entries

    • getUserFeedEntries

      @NotAuditable List<String> getUserFeedEntries(String userId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, Set<String> userFilter, Set<String> 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
      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)
      excludeOtherUsers - - 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 List<ActivityFeedEntity> getUserFeedEntries(String feedUserId, 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:
      feedUserId - - 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)
      excludeOtherUsers - - if TRUE then will exclude activities for other users (hence returning this user only)
      minFeedId - - inclusive from min feed DB id, if -1 then return all available
      Returns:
      list of JSON feed entries

    • getUserFeedEntries

      @NotAuditable List<ActivityFeedEntity> getUserFeedEntries(String feedUserId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, Set<String> userFilter, Set<String> 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:
      feedUserId - - 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)
      excludeOtherUsers - - 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
      minFeedId - - inclusive from min feed DB id, if -1 then return all available
      Returns:
      list of JSON feed entries

    • getPagedUserFeedEntries

      @NotAuditable org.alfresco.query.PagingResults<ActivityFeedEntity> getPagedUserFeedEntries(String feedUserId, String siteId, boolean excludeThisUser, boolean excludeOtherUsers, long minFeedId, org.alfresco.query.PagingRequest pagingRequest)

    • getSiteFeedEntries

      @NotAuditable List<String> getSiteFeedEntries(String siteId)
      Retrieve site feed
      Parameters:
      siteId - - required
      Returns:
      list of JSON feed entries

    • getMaxFeedItems

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

    • 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 List<FeedControl> getFeedControls(String userId)
      For given user, get feed controls
      Parameters:
      userId - - required (must match
      Returns:
      list of user feed controls

    • getFeedControls

      @NotAuditable List<FeedControl> 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