blackboard.data.discussionboard.datamanager
Interface ConferenceManager

public interface ConferenceManager

Method Summary

void	deleteById(Id id) Remove a conference.
ConferenceOwner.OwnerType	getConferenceOwnerType(Conference conf) Returns the conference owner type for the given conference
Course	getEnclosingCourse(Conference conf) If the conference owner of this conference is a course, return it, if it is a group, get the enclosing course and return that.
java.util.List	loadByCourseId(Id id) Load all the conferences that belong to a course with a given course Id
Conference	loadById(Id id) Given an Id, load the conference.
java.util.List	loadSystemConferences() Get all community system conferences.
java.util.List	loadSystemConferences(boolean isAvailable, DbObjectMap map) Load all system conferences by availability
java.util.List	loadUsersByCourseId(Id id) Load all the users in the course.
java.util.List	loadUsersByGroupId(Id id) Load all the users in the group.
java.util.List	loadWithStatusByCourseId(Id id) Load all the conferences that belong to a course with a given course Id.
void	reposition(Id conf_id, int position) Set the new position of a conference.
void	save(Conference conference) Save a conference.

Method Detail

loadSystemConferences

java.util.List loadSystemConferences()
                                     throws KeyNotFoundException,
                                            PersistenceException

Get all community system conferences.

Returns:

List of system conference

Throws:

KeyNotFoundException - Will never be thrown.

PersistenceException - if some other error occurs while loading the object

deleteById

void deleteById(Id id)
                throws PersistenceException

Remove a conference.

Parameters:

id -

Throws:

PersistenceException - if some other error occurs while loading the object

save

void save(Conference conference)
          throws PersistenceException,
                 ValidationException

Save a conference.

Parameters:

conference -

Throws:

PersistenceException - if some other error occurs while loading the object

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

loadById

Conference loadById(Id id)
                    throws PersistenceException

Given an Id, load the conference.

Parameters:

id -

Returns:

Conference

Throws:

PersistenceException

loadUsersByCourseId

java.util.List loadUsersByCourseId(Id id)
                                   throws PersistenceException

Load all the users in the course. The returned list contains CourseMembership objects with User attribute.

Parameters:

id -

Returns:

list of conference users

Throws:

PersistenceException - if some other error occurs while loading the object.

loadUsersByGroupId

java.util.List loadUsersByGroupId(Id id)
                                  throws PersistenceException

Load all the users in the group. The returned list contains CourseMembership objects with User attribute.

Parameters:

id -

Returns:

list of conference users

Throws:

PersistenceException - if some other error occurs while loading the object.

reposition

void reposition(Id conf_id,
                int position)
                throws PersistenceException

Set the new position of a conference. This only makes sense for Community Boards.

Parameters:

conf_id -

position -

Throws:

PersistenceException

loadByCourseId

java.util.List loadByCourseId(Id id)
                              throws PersistenceException

Load all the conferences that belong to a course with a given course Id

Parameters:

id - course id

Returns:

list of conference

Throws:

PersistenceException

loadWithStatusByCourseId

java.util.List loadWithStatusByCourseId(Id id)
                                        throws PersistenceException

Load all the conferences that belong to a course with a given course Id. The returned list contains status.

Parameters:

id - course id

Returns:

list of conference

Throws:

PersistenceException

loadSystemConferences

java.util.List loadSystemConferences(boolean isAvailable,
                                     DbObjectMap map)
                                     throws KeyNotFoundException,
                                            PersistenceException

Load all system conferences by availability

Parameters:

isAvailable - - only load available system conferences if true

Returns:

List

Throws:

KeyNotFoundException - Will never be thrown.

PersistenceException - if some other error occurs while loading the object

getConferenceOwnerType

ConferenceOwner.OwnerType getConferenceOwnerType(Conference conf)
                                                 throws PersistenceException

Returns the conference owner type for the given conference

Parameters:

conf -

Returns:

Throws:

PersistenceException

Since:

7.4

getEnclosingCourse

Course getEnclosingCourse(Conference conf)
                          throws PersistenceException

If the conference owner of this conference is a course, return it, if it is a group, get the enclosing course and return that.

Parameters:

conf -

Returns:

Throws:

PersistenceException

Since:

7.4