Interface Enrollment

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Enrollment extends OsidRelationship

An Enrollment is an OsidRelationship between a student and a ProgramOffering.

  • Method Details

    • getProgramOfferingId

      Id getProgramOfferingId()
      Gets the program offering Id associated with this registration.
      Returns:
      the program offering Id
      Compliance:
      mandatory - This method must be implemented.

    • getProgramOffering

      ProgramOffering getProgramOffering() throws OperationFailedException
      Gets the program offering associated with this registration.
      Returns:
      the program offering
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getStudentId

      Id getStudentId()
      Gets the Id of the student Resource.
      Returns:
      the Resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getStudent

      Resource getStudent() throws OperationFailedException
      Gets the student Resource.
      Returns:
      the student
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isPartOf

      boolean isPartOf()
      Tests if this enrollment is part of another enrollment.
      Returns:
      true if this enrollment has a parent, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getParentEnrollmentId

      Id getParentEnrollmentId()
      Gets the Id for the parent enrollment.
      Returns:
      the parent enrollment Id
      Throws:
      IllegalStateException - isPartOf() is false
      Compliance:
      mandatory - This method must be implemented.

    • getParentEnrollment

      Enrollment getParentEnrollment() throws OperationFailedException
      Gets the parent enrollment.
      Returns:
      the parent enrollment
      Throws:
      IllegalStateException - isPartOf() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getEnrollmentRecord

      EnrollmentRecord getEnrollmentRecord(Type enrollmentRecordType) throws OperationFailedException
      Gets the enrollment record corresponding to the given Enrollment record Type. This method is used to retrieve an object implementing the requested record. The enrollmentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(enrollmentRecordType) is true.
      Parameters:
      enrollmentRecordType - the type of enrollment record to retrieve
      Returns:
      the enrollment record
      Throws:
      NullArgumentException - enrollmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(enrollmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.