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

Interface	osid.course.program.EnrollmentForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.program.batch.EnrollmentBatchForm`
Used By	`osid.course.program.EnrollmentAdminSession`
Description	This is the form for creating and updating `Enrollments`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `EnrollmentAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getParentEnrollmentMetadata
Description	Gets the metadata for the parent enrollment.
Return	`osid.Metadata`		metadata for the parent enrollment
Compliance	`mandatory`		This method must be implemented.
Method	setParentEnrollment
Description	Sets the parent enrollment.
Parameters	`osid.id.Id`	`enrollmentId`	the new parent enrollment
Errors	INVALID_ARGUMENT		`enrollmentId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`enrollmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentEnrollment
Description	Removes the parent enrollment.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentFormRecord
Description	Gets the `EnrollmentFormRecord` corresponding to the given enrollment record `Type`.
Parameters	`osid.type.Type`	`enrollmentRecordType`	an enrollment record type
Return	`osid.course.program.records.EnrollmentFormRecord`		the enrollment form 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.