OSID - osid.course.registration.request.RegistrationRequestItemForm Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestItemForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Used By	`osid.course.registration.request.RegistrationRequestItemAdminSession`
Description	This is the form for creating and updating `RegistrationRequ` estItems. Like all `OsidForms` , various data elements may be set here for use in the create and update methods in the `RegistrationRequestItemAdmi` nSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getStudentMetadata
Description	Gets the metadata for the student.
Return	`osid.Metadata`		metadata for the student
Compliance	`mandatory`		This method must be implemented.
Method	setStudent
Description	Sets the student resource.
Parameters	`osid.id.Id`	`resourceId`	the new student
Errors	INVALID_ARGUMENT		`resourceiId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStudent
Description	Removes the student.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetMetadata
Description	Gets the metadata for the registration target.
Return	`osid.Metadata`		metadata for the registration target
Compliance	`mandatory`		This method must be implemented.
Method	setRegistrationTarget
Description	Sets the registration target.
Parameters	`osid.id.Id`	`registrationTargetId`	the new student
Errors	INVALID_ARGUMENT		`registrationTargetId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`registrationTargetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationTarget
Description	Removes the registration target.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getExistingRegistrationMetadata
Description	Gets the metadata for the existing registration.
Return	`osid.Metadata`		metadata for the existing registration
Compliance	`mandatory`		This method must be implemented.
Method	setExistingRegistration
Description	Sets the existing registration.
Parameters	`osid.id.Id`	`registrationId`	the new existing registration
Errors	INVALID_ARGUMENT		`registrationId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`registrationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExistingRegistration
Description	Removes the existing registration.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditOptionMetadata
Description	Gets the metadata for the credit option.
Return	`osid.Metadata`		metadata for the credit option
Compliance	`mandatory`		This method must be implemented.
Method	setCreditOption
Description	Sets the credit option.
Parameters	`decimal`	`credits`	the new credit option
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditOption
Description	Removes the credit option.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptionMetadata
Description	Gets the metadata for the grading option.
Return	`osid.Metadata`		metadata for the grading option
Compliance	`mandatory`		This method must be implemented.
Method	setGradingOption
Description	Sets the grading option.
Parameters	`osid.id.Id`	`gradeSystemId`	the new grading option
Errors	INVALID_ARGUMENT		`gradeSystemId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradingOption
Description	Removes the grading option.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemFormRecord
Description	Gets the `RegistrationRequestItemFormRecord` corresponding to the given registration request item record `Type` .
Parameters	`osid.type.Type`	`registrationRequestItemRecordType`	a registration request item record type
Return	`osid.course.registration.request.records.RegistrationRequestItemFormRecord`		the registration request item form record
Errors	NULL_ARGUMENT		`registrationRequestItemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationRequestItemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.