Interface RegistrationTarget

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface RegistrationTarget extends OsidObject, Subjugateable

A RegistrationTarget represents a set of Activities in which a Registration is permissible.

  • Method Details

    • getCourseOfferingId

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

    • getCourseOffering

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

    • getActivityIds

      IdList getActivityIds()
      Gets the activity Ids in this registration target.
      Returns:
      Ids of the l earning objectives
      Compliance:
      mandatory - This method is must be implemented.

    • getActivities

      ActivityList getActivities() throws OperationFailedException
      Gets the activities in this registration target.
      Returns:
      the activites
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • definesCredits

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

    • getCredits

      BigDecimal[] getCredits()
      Gets the number of credits available to register for in this course. Each array element is a distinct option.
      Returns:
      the number of credits
      Throws:
      IllegalStateException - definesCredits() is false
      Compliance:
      mandatory - This method must be implemented.

    • isGraded

      boolean isGraded()
      Tests if a registration to this registration target. will be for for grades.
      Returns:
      true if this registration is for grades, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionIds

      IdList getGradingOptionIds()
      Gets the various grading option Ids available to register in this course.
      Returns:
      the returned list of grading option Ids
      Throws:
      IllegalStateException - isGraded() is false
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptions

      GradeSystemList getGradingOptions() throws OperationFailedException
      Gets the various grading options available to register in this course.
      Returns:
      the returned list of grading options
      Throws:
      IllegalStateException - isGraded() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetRecord

      RegistrationTargetRecord getRegistrationTargetRecord(Type registrationTargetRecordType) throws OperationFailedException
      Gets the registration target record corresponding to the given RegistrationT arget record Type. This method ie used to retrieve an object implementing the requested record. The registrationTargetRecor dType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(registrationTargetRecordT ype) is true.
      Parameters:
      registrationTargetRecordType - the type of registration target record to retrieve
      Returns:
      the registration target record
      Throws:
      NullArgumentException - registrationTargetRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(registrationTargetRecordType) is false
      Compliance:
      mandatory - This method must be implemented.