org.sakaiproject.portal.api

Interface BullhornService

public interface BullhornService

Service for the bullhorn alerts at the top of the portal

Author:

Adrian Fish

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACADEMIC Used by the bullhorn alerts code
static String	SOCIAL Used by the bullhorn alerts code

Method Summary

Modifier and Type	Method and Description
boolean	clearAllAcademicAlerts(String userId)
boolean	clearAllSocialAlerts(String userId)
boolean	clearBullhornAlert(String userId, long alertId)
long	getAcademicAlertCount(String userId)
List<BullhornAlert>	getAcademicAlerts(String userId)
long	getSocialAlertCount(String userId)
List<BullhornAlert>	getSocialAlerts(String userId)

Field Detail

ACADEMIC

static final String ACADEMIC

Used by the bullhorn alerts code

See Also:

Constant Field Values

SOCIAL

static final String SOCIAL

Used by the bullhorn alerts code

See Also:

Constant Field Values

Method Detail

getSocialAlertCount

long getSocialAlertCount(String userId)

Parameters:

userId - The user to retrieve the alert count for

Returns:

the number of current social alerts for the specified user

getSocialAlerts

List<BullhornAlert> getSocialAlerts(String userId)

Parameters:

userId - The user to retrieve alerts for

Returns:

the list of current social alerts for the specified user

clearAllSocialAlerts

boolean clearAllSocialAlerts(String userId)

Parameters:

userId - The user to clear the alerts for

Returns:

boolean to indicate success

getAcademicAlertCount

long getAcademicAlertCount(String userId)

Parameters:

userId - The user to retrieve the alert count for

Returns:

the number of current academic alerts for the specified user

getAcademicAlerts

List<BullhornAlert> getAcademicAlerts(String userId)

Parameters:

userId - The user to retrieve alerts for

Returns:

the list of current academic alerts for the specified user

clearBullhornAlert

boolean clearBullhornAlert(String userId,
                           long alertId)

Parameters:

userId - The user to clear the alert for

alertId - The alert to clear

Returns:

boolean to indicate success

clearAllAcademicAlerts

boolean clearAllAcademicAlerts(String userId)

Parameters:

userId - The user to clear the alerts for

Returns:

boolean to indicate success