org.osid.course

Interface CourseCatalog

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface CourseCatalog
extends OsidCatalog

A CourseCatalog represents a collection of courses, course offerings and terms.

Method Summary

Methods

Modifier and Type	Method and Description
CourseCatalogRecord	getCourseCatalogRecord(Type courseCatalogRecordType) Gets the course catalog record corresponding to the given CourseCatalog record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCourseCatalogRecord

CourseCatalogRecord getCourseCatalogRecord(Type courseCatalogRecordType)
                                           throws OperationFailedException

Gets the course catalog record corresponding to the given CourseCatalog record Type. This method is used to retrieve an object implementing the requested record. The courseCatalogRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(courseCatalogRecordType) is true .

Parameters:

courseCatalogRecordType - the type of course catalog record to retrieve

Returns:

the course catalog record

Throws:

NullArgumentException - courseCatalogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseCatalogRecordType) is false

Compliance:

mandatory - This method must be implemented.