org.sakaiproject.profile2.logic
Interface ProfileWallLogic

public interface ProfileWallLogic

Logic interface for the Profile2 wall.

Author:

d.b.robinson@lancaster.ac.uk

Method Summary

boolean	addNewCommentToWallItem(WallItemComment wallItemComment) Adds a new wall item comment.
void	addNewEventToWall(String event, String userUuid) Notifies a user's connections of an event added to the user's wall.
void	addNewStatusToWall(String status, String userUuid) Notifies a user's connections of a status update added to the user's wall.
int	getWallItemsCount(String userUuid) Returns the number of available wall items for the specified user.
int	getWallItemsCount(String userUuid, ProfilePrivacy privacy) Returns the number of available wall items for the specified user.
List<WallItem>	getWallItemsForUser(String userUuid) Returns the wall for the specified user.
List<WallItem>	getWallItemsForUser(String userUuid, ProfilePrivacy privacy) Returns the wall for the specified user.
boolean	postWallItemToWall(String userUuid, WallItem wallItem) Posts the specified wall item to the specified user's wall and the walls of their connections.
boolean	removeWallItemFromWall(WallItem wallItem) Removes the specified wall item.

Method Detail

addNewEventToWall

void addNewEventToWall(String event,
                       String userUuid)

Notifies a user's connections of an event added to the user's wall. Note: the wall logic is currently responsible for timestamping the event, but we might want to pass the date in this API call instead.

Parameters:

event - the event to add.

userUuid - the ID of the user that created the event.

addNewStatusToWall

void addNewStatusToWall(String status,
                        String userUuid)

Notifies a user's connections of a status update added to the user's wall. Note: the wall logic is currently responsible for timestamping the status update, but we might want to pass the date in this API call instead.

Parameters:

status - the status to add.

userUuid - the ID of the user whose status we're posting.

addNewCommentToWallItem

boolean addNewCommentToWallItem(WallItemComment wallItemComment)

Adds a new wall item comment.

Parameters:

wallItemComment - the wall item comment to add.

Returns:

true if the add is successful and false if the add fails.

postWallItemToWall

boolean postWallItemToWall(String userUuid,
                           WallItem wallItem)

Posts the specified wall item to the specified user's wall and the walls of their connections.

Parameters:

userUuid - the id of the user whose wall we're posting to.

wallItem - the wall item to post.

removeWallItemFromWall

boolean removeWallItemFromWall(WallItem wallItem)

Removes the specified wall item.

Parameters:

wallItem - the wall item to remove.

getWallItemsForUser

List<WallItem> getWallItemsForUser(String userUuid)

Returns the wall for the specified user. The privacy record will be looked up.

Parameters:

userUuid - the user to query by.

Returns:

the wall for the specified user.

getWallItemsForUser

List<WallItem> getWallItemsForUser(String userUuid,
                                   ProfilePrivacy privacy)

Returns the wall for the specified user. Privacy settings are used to determine if the user is allowed to access the requested wall.

Parameters:

userUuid - the user to query by.

privacy - the privacy record for the user.

Returns:

the wall for the specified user.

getWallItemsCount

int getWallItemsCount(String userUuid)

Returns the number of available wall items for the specified user. The privacy record will be looked up.

Parameters:

userUuid - the user to query by.

Returns:

the number of available wall items for the specified user.

getWallItemsCount

int getWallItemsCount(String userUuid,
                      ProfilePrivacy privacy)

Returns the number of available wall items for the specified user. Privacy settings are used to determine if the user is allowed to access the requested wall items.

Parameters:

userUuid - the user to query by.

privacy - the privacy record for the user.

Returns:

the number of available wall items for the specified user.