blackboard.data.discussionboard.datamanager
Interface ForumManager

public interface ForumManager

Method Summary

void	delete(Forum obj) Delete forum.
java.lang.String	getForumProperty(java.lang.String key, Id forumId) Get an individual forum property by key.
java.util.List	loadByConferenceId(Id conferenceId) get all the forums belong to the same conference by the conference id
java.util.List	loadByCourseId(Id courseId) get all the forums belonging to all the conferences in a course by the course id
Forum	loadById(Id forumId) get the forum object by the forum id
ForumProperties	loadPropertiesById(Id forumId) Get the forum property settings.
void	save(Forum obj) Save forum.
void	saveProperties(ForumProperties fp) Save the forum property settings.
void	setForumProperty(java.lang.String key, java.lang.String value, Id forumId) Set an individual forum property by key & value.

Method Detail

save

void save(Forum obj)
          throws PersistenceException,
                 ValidationException

Save forum.

Parameters:

obj -

Throws:

PersistenceException

ValidationException

delete

void delete(Forum obj)
            throws PersistenceException

Delete forum.

Parameters:

obj -

Throws:

PersistenceException

loadByConferenceId

java.util.List loadByConferenceId(Id conferenceId)
                                  throws PersistenceException,
                                         KeyNotFoundException

get all the forums belong to the same conference by the conference id

Parameters:

conferenceId -

Returns:

Throws:

PersistenceException

KeyNotFoundException

loadByCourseId

java.util.List loadByCourseId(Id courseId)
                              throws PersistenceException,
                                     KeyNotFoundException

get all the forums belonging to all the conferences in a course by the course id

Parameters:

conferenceId -

Returns:

Throws:

PersistenceException

KeyNotFoundException

loadById

Forum loadById(Id forumId)
               throws PersistenceException,
                      KeyNotFoundException

get the forum object by the forum id

Parameters:

forumId -

Returns:

Throws:

PersistenceException

KeyNotFoundException

loadPropertiesById

ForumProperties loadPropertiesById(Id forumId)
                                   throws PersistenceException,
                                          KeyNotFoundException

Get the forum property settings.

Parameters:

forumId -

Returns:

ForumProperties

Throws:

PersistenceException

KeyNotFoundException

saveProperties

void saveProperties(ForumProperties fp)
                    throws PersistenceException,
                           ValidationException

Save the forum property settings.

Parameters:

fp -

Throws:

PersistenceException

ValidationException

setForumProperty

void setForumProperty(java.lang.String key,
                      java.lang.String value,
                      Id forumId)
                      throws PersistenceException,
                             ValidationException

Set an individual forum property by key & value.

Parameters:

key -

value -

forumId -

Throws:

PersistenceException

ValidationException

getForumProperty

java.lang.String getForumProperty(java.lang.String key,
                                  Id forumId)
                                  throws PersistenceException

Get an individual forum property by key.

Parameters:

key -

forumId -

Returns:

String

Throws:

PersistenceException