Interface Plan

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
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 .

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

    • getCourseOfferingId

      Id getCourseOfferingId()
      Gets the Id of the course offering.
      Returns:
      the course offering Id
      Compliance:
      mandatory - This method must be implemented.

    • getCourseOffering

      CourseOffering getCourseOffering() throws OperationFailedException
      Gets the course offering.
      Returns:
      the course offering
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getModuleIds

      IdList getModuleIds()
      Gets the modules to apply to this plan.
      Returns:
      the module Ids
      Compliance:
      mandatory - This method must be implemented.

    • getModules

      ModuleList getModules() throws OperationFailedException
      Gets the modules to apply to this plan.
      Returns:
      the module
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPlanRecord

      PlanRecord getPlanRecord(Type planRecordType) throws OperationFailedException
      Gets the plan record corresponding to the given 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 .
      Parameters:
      planRecordType - the type of plan record to retrieve
      Returns:
      the plan record
      Throws:
      NullArgumentException - planRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(planRecordType) is false
      Compliance:
      mandatory - This method must be implemented.