org.sakaiproject.api.edu.coursemanagement
Interface CourseSet

All Superinterfaces:
Persistable
All Known Implementing Classes:
CourseSetImpl

public interface CourseSet
extends Persistable

A CourseSet is a set of canonical courses that can be used to describe majors, departments and other high level collections of canonical courses. This information may be part of the organizational hierarchy (SakaiSuperStructure), or it may cut across the hierarchy. This distinction is left as an implementation detail to be defined.

Author:
Mark Norton

Method Summary
 void addCanonicalCourse(String canonicalCourseUuid)
          Add a canonical course uuid to this set.
 Set getCanonicalCourses()
          Get a set of canonical course uuids that are contained in this set.
 String getContext()
          This allows CourseSet to be rooted in the sakai structure
 String getTitle()
          Get the title of this course set.
 void removeCanonicalCourse(String canonicalCourseUuid)
          Remove a canonical course uuid from this set.
 void setContext(String uuid)
          Set the context of this course set.
 void setTitle(String title)
          Set the title of this course set.
 
Methods inherited from interface org.sakaiproject.api.common.manager.Persistable
getCreatedBy, getCreatedDate, getLastModifiedBy, getLastModifiedDate, getUuid
 

Method Detail

getTitle

public String getTitle()
Get the title of this course set.

Returns:
course title.

setTitle

public void setTitle(String title)
Set the title of this course set.

Parameters:
title -

getCanonicalCourses

public Set getCanonicalCourses()
Get a set of canonical course uuids that are contained in this set.

Returns:
set of canonical course uuids.

addCanonicalCourse

public void addCanonicalCourse(String canonicalCourseUuid)
Add a canonical course uuid to this set.

Parameters:
canonicalCourseUuid -

removeCanonicalCourse

public void removeCanonicalCourse(String canonicalCourseUuid)
Remove a canonical course uuid from this set.

Parameters:
canonicalCourseUuid -

getContext

public String getContext()
This allows CourseSet to be rooted in the sakai structure

Returns:
uuid

setContext

public void setContext(String uuid)
Set the context of this course set.

Parameters:
uuid -