org.osid.course.program

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 Summary

Methods

Modifier and Type	Method and Description
EnrollmentRecord	getEnrollmentRecord(Type enrollmentRecordType) Gets the enrollment record corresponding to the given Enrollment record Type.
ProgramOffering	getProgramOffering() Gets the program offering associated with this registration.
Id	getProgramOfferingId() Gets the program offering Id associated with this registration.
Resource	getStudent() Gets the student Resource.
Id	getStudentId() Gets the Id of the student Resource.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

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.

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.