Interface Registration

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

A Registration is an OsidRelationship between a student and a CourseRegistration for a RegistrationTarget .

  • Method Details

    • getCourseRegistrationId

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

    • getCourseRegistration

      CourseRegistration getCourseRegistration() throws OperationFailedException
      Gets the course registration associated with this registration.
      Returns:
      the course registration
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetId

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

    • getRegistrationTarget

      RegistrationTarget getRegistrationTarget() throws OperationFailedException
      Gets the registration target associated with this registration.
      Returns:
      the registration target
      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 Student 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.

    • definesCredits

      boolean definesCredits()
      Tests if this registration defines credits to be earned.
      Returns:
      true if this registration has credits, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCredits

      BigDecimal[] getCredits()
      Gets the number of credits the student is registered to earn. Multiple credit options indicates a set of credits to be determined at the completion of the course.
      Returns:
      the number of credits
      Throws:
      IllegalStateException - definesCredits() is false
      Compliance:
      mandatory - This method must be implemented.

    • isGraded

      boolean isGraded()
      Tests if this registration includes a specific grading option.
      Returns:
      true if this course is graded, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionId

      Id getGradingOptionId()
      Gets the grading option Id for this registration.
      Returns:
      the grading option Id
      Throws:
      IllegalStateException - isGraded() is false
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOption

      GradeSystem getGradingOption() throws OperationFailedException
      Gets the grading option for this registration.
      Returns:
      a grading system
      Throws:
      IllegalStateException - isGraded() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRecord

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