blackboard.data.discussionboard.datamanager
Interface UserForumSettingsManager

public interface UserForumSettingsManager

Method Summary

java.util.List	loadAllByForumId(Id forum_id) Load all the users' forum settings by forum_id
UserForumSettings	loadByForumAndUserId(Id forum_id, Id user_id) Load the UserForumSettings object for the given forum id (Identified by forum_id) and user id (Identified by user_id).
java.util.Map	loadForumRoleHashByForumId(Id forum_id) Load all the users' forum roles in a hash for look up.
void	save(UserForumSettings ufs) Inserts or updates the supplied UserForumSettings object

Method Detail

save

void save(UserForumSettings ufs)
          throws PersistenceException,
                 ValidationException

Inserts or updates the supplied UserForumSettings object

Parameters:

ufs - UserForumSetting needs to be saved

Throws:

ValidationException - if the object is not in a consistent state to be persisted.

PersistenceException - if some other exception happens while persisting the object.

loadAllByForumId

java.util.List loadAllByForumId(Id forum_id)
                                throws PersistenceException

Load all the users' forum settings by forum_id

Parameters:

forum_id. -

Returns:

A list containing all the users' settings objects for that forum.

Throws:

PersistenceException - if some other exception happens while persisting the object.

loadForumRoleHashByForumId

java.util.Map loadForumRoleHashByForumId(Id forum_id)
                                         throws PersistenceException

Load all the users' forum roles in a hash for look up. Username is the Key, UserForumSettings.ForumRole is the value.

Parameters:

forum_id -

Throws:

PersistenceException - if some other exception happens while persisting the object.

loadByForumAndUserId

UserForumSettings loadByForumAndUserId(Id forum_id,
                                       Id user_id)
                                       throws KeyNotFoundException,
                                              PersistenceException

Load the UserForumSettings object for the given forum id (Identified by forum_id) and user id (Identified by user_id).

Parameters:

forum_id. -

user_id -

Returns:

A list contains setting whit pointed forum id.

Throws:

KeyNotFoundException - if there is no UserForumSettings in the database with the given forum id and user id

PersistenceException - if some other exception happens while persisting the object.