public interface Module extends OsidGovernator, Subjugateable
A Module
is a major portion of a Syllabus
and may have a related set of Docets.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
Id getSyllabusId()
Id
of the syllabus. Id
mandatory
- This method must be implemented. Syllabus getSyllabus() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ModuleRecord getModuleRecord(Type moduleRecordType) throws OperationFailedException
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
.moduleRecordType
- the type of module record to retrieveNullArgumentException
- moduleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(moduleRecordType)
is false
mandatory
- This method must be implemented.