public interface Plan extends OsidRelationship
A Plan
is an OsidRelationship
to apply a
Syllabus
to a CourseOffering.
The
Plans
within a Plan
must be to the same
Syllabus
indicated by the Plan
and the
CourseOffering
must be to the same Course
as the
Syllabus.
Modifier and Type | Method and Description |
---|---|
CourseOffering |
getCourseOffering()
Gets the course offering.
|
Id |
getCourseOfferingId()
Gets the
Id of the course offering. |
IdList |
getModuleIds()
Gets the modules to apply to this plan.
|
ModuleList |
getModules()
Gets the modules to apply to this plan.
|
PlanRecord |
getPlanRecord(Type planRecordType)
Gets the plan record corresponding to the given
Plan
record Type. |
Syllabus |
getSyllabus()
Gets the syllabus.
|
Id |
getSyllabusId()
Gets the
Id of the syllabus. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
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. Id getCourseOfferingId()
Id
of the course offering. Id
mandatory
- This method must be implemented. CourseOffering getCourseOffering() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getModuleIds()
Ids
mandatory
- This method must be implemented. ModuleList getModules() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. PlanRecord getPlanRecord(Type planRecordType) throws OperationFailedException
Plan
record Type.
This method must be used to retrieve an
object implementing the requested record. The planRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(planRecordType)
is true
.planRecordType
- the type of plan record to retrieveNullArgumentException
- planRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(planRecordType)
is false
mandatory
- This method must be implemented.