com.jivesoftware.community
Interface RecentActivityInfoProvider

All Known Implementing Classes:

BaseRecentActivityInfoProvider

public interface RecentActivityInfoProvider

The recent activity subsystem (listeners and manager) will use subtypes of this interface to record activities, and present them to users.

Method Summary

boolean	eventsHandledExclusivelyByCustomListener() This method should return true if a listener has been registered to handle events exclusively, bypassing the generic activity event listener in the core code.
User	getAssignedUser(JiveObject object, Activity activity) If the activity involves assignment to a user, this method returns who.
ActivityEventHandlingStrategy	getEventHandlingStrategy() Returns a strategy object for dealing with recent activity events.
String	getObjectUrl(JiveObject object, boolean constructAbsoluteURL) Returns the relative URL link constructed from the object.
boolean	isHideActivityDetail(Activity activity) Based on the activity, determine whether or not details of the activity are hidden in the UI.
boolean	isUserAuthorizedToViewActivity(Activity activity, User user) Returns true if the supplied user is allowed to view the supplied activity.

Method Detail

isUserAuthorizedToViewActivity

boolean isUserAuthorizedToViewActivity(Activity activity,
                                       User user)

Returns true if the supplied user is allowed to view the supplied activity. Typical implementation would be to check whether or not the user is allowed to view (load) the target jiveObject of the activity.

Parameters:

activity - the activity

user - the user

Returns:

true if the supplied user is allowed to view the supplied activity

getAssignedUser

User getAssignedUser(JiveObject object,
                     Activity activity)

If the activity involves assignment to a user, this method returns who.

Parameters:

object - the jive object

activity - the activity

Returns:

the assigned user in the activity, if any

getObjectUrl

String getObjectUrl(JiveObject object,
                    boolean constructAbsoluteURL)

Returns the relative URL link constructed from the object. Typically used for rendering recent activity list items.

Parameters:

object - the jive object

constructAbsoluteURL -

Returns:

the relative or absolute URL link constructed from the object

isHideActivityDetail

boolean isHideActivityDetail(Activity activity)

Based on the activity, determine whether or not details of the activity are hidden in the UI. You may check perms based on the user associated with the activity, for example.

Parameters:

activity - the activity

Returns:

whether or not details of the activity are hidden in the UI

eventsHandledExclusivelyByCustomListener

boolean eventsHandledExclusivelyByCustomListener()

This method should return true if a listener has been registered to handle events exclusively, bypassing the generic activity event listener in the core code.

Returns:

true if a listener has been registered to handle events exclusively

getEventHandlingStrategy

ActivityEventHandlingStrategy getEventHandlingStrategy()

Returns a strategy object for dealing with recent activity events. Implement this if you don't want to register a whole other recent activity event listener for your type.

Returns:

a strategy object for dealing with recent activity events