org.osid.course.syllabus

Interface Module

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Sourceable, Subjugateable

public interface Module
extends OsidGovernator, Subjugateable

A Module is a major portion of a Syllabus and may have a related set of Docets.

Method Summary

Methods

Modifier and Type	Method and Description
ModuleRecord	getModuleRecord(Type moduleRecordType) Gets the module record corresponding to the given Module record Type.
Syllabus	getSyllabus() Gets the syllabus.
Id	getSyllabusId() Gets the Id of the syllabus.

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.Operable

isActive, isDisabled, isEnabled, isOperational

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSyllabusId

Id getSyllabusId()

Gets the Id of the syllabus.

Returns:

the syllabus Id

Compliance:

mandatory - This method must be implemented.

getSyllabus

Syllabus getSyllabus()
                     throws OperationFailedException

Gets the syllabus.

Returns:

the syllabus

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getModuleRecord

ModuleRecord getModuleRecord(Type moduleRecordType)
                             throws OperationFailedException

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

Parameters:

moduleRecordType - the type of module record to retrieve

Returns:

the module record

Throws:

NullArgumentException - moduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(moduleRecordType) is false

Compliance:

mandatory - This method must be implemented.