Interface Module

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Module
extends OsidObject, Subjugateable

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

Method Summary

Modifier and Type	Method	Description
ModuleRecord	getModuleRecord(Type moduleRecordType)	Gets the module record corresponding to the given Module record Type .This method is used to retrieve an object implementing the requested record.
Syllabus	getSyllabus()	Gets the syllabus.
Id	getSyllabusId()	Gets the Id of the syllabus.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

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.