OSID - osid.course.program.Enrollment Service Interface Definition

Interface	osid.course.program.Enrollment
Implements	`osid.OsidRelationship`
Used By	`osid.course.program.Enrollment`
	`osid.course.program.EnrollmentAdminSession`
	`osid.course.program.EnrollmentList`
	`osid.course.program.EnrollmentLookupSession`
Description	An `Enrollment` is an `OsidRelationship` between a student and a `ProgramOffering`.
Method	getProgramOfferingId
Description	Gets the program offering `Id` associated with this registration.
Return	`osid.id.Id`		the program offering `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOffering
Description	Gets the program offering associated with this registration.
Return	`osid.course.program.ProgramOffering`		the program offering
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getStudentId
Description	Gets the `Id` of the student `Resource`.
Return	`osid.id.Id`		the `Resource` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStudent
Description	Gets the student `Resource`.
Return	`osid.resource.Resource`		the student
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isPartOf
Description	Tests if this enrollment is part of another enrollment.
Return	`boolean`		`true` if this enrollment has a parent, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentEnrollmentId
Description	Gets the `Id` for the parent enrollment.
Return	`osid.id.Id`		the parent enrollment `Id`
Errors	ILLEGAL_STATE		`isPartOf()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getParentEnrollment
Description	Gets the parent enrollment.
Return	`osid.course.program.Enrollment`		the parent enrollment
Errors	ILLEGAL_STATE		`isPartOf()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentRecord
Description	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	`osid.type.Type`	`enrollmentRecordType`	the type of enrollment record to retrieve
Return	`osid.course.program.records.EnrollmentRecord`		the enrollment record
Errors	NULL_ARGUMENT		`enrollmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(enrollmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.