Interface ActivityRegistration

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

An ActivityRegistration is an OsidRelationship between a student and an Activity for a CourseRegistration .

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

    • getActivityId

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

    • getActivity

      Activity getActivity() throws OperationFailedException
      Gets the activity associated with this registration.
      Returns:
      the activity
      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.

    • getActivityRegistrationRecord

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