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

Interface	osid.course.registration.request.RegistrationRequestItem
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Used By	`osid.course.registration.request.RegistrationRequestItemAdminSession`
	`osid.course.registration.request.RegistrationRequestItemList`
	`osid.course.registration.request.RegistrationRequestItemLookupSession`
Description	A `RegistrationRequestItem` supports several operations: ADD: Registers the student into the designated `RegistrationTarget`. DROP: Ends the existing `Registration`. UPDATE: Swaps the existing `Registration` with the `RegistrationTarget` and/or updates the credit and grading options.
Method	getRegistrationRequestId
Description	Gets the `Id` of the registration request.
Return	`osid.id.Id`		the registration request `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequest
Description	Gets the registration request,
Return	`osid.course.registration.request.RegistrationRequest`		the registration request
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getStudentId
Description	Gets the `Id` of the student resource for whom this applies.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStudent
Description	Gets the student resource for whom this applies.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationOperation
Description	Gets the operation.
Return	`osid.course.registration.request.RegistrationOperation`		the operation
Compliance	`mandatory`		This method must be implemented.
Method	getRegsistrationTargetId
Description	Gets the `Id` of the registration target. A registration target must exist for valid ADD and UPDATE operations.
Return	`osid.id.Id`		the registration target `Id`
Errors	ILLEGAL_STATE		`getOperation()`!= `ADD` and `getOperation()`!= `UPDATE`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTarget
Description	Gets the registration target. A registration target must exist for valid ADD and UPDATE operations.
Return	`osid.course.registration.RegistrationTarget`		the registration target
Errors	ILLEGAL_STATE		`getOperation()`!= `ADD` and `getOperation()`!= `UPDATE`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getExixtingRegsistrationId
Description	Gets the `Id` of the existing registration to be dropped or updated. An existing registration must exist for valid UPDATE and DROP operations.
Return	`osid.id.Id`		the existing registration `Id`
Errors	ILLEGAL_STATE		`getOperation()`!= `UPDATE` and `getOperation()`!= `DROP`
Compliance	`mandatory`		This method must be implemented.
Method	getExistingRegistration
Description	Gets the existing registration to be dropped or updated. An existing registration must exist for valid UPDATE and DROP operations.
Return	`osid.course.registration.Registration`		the existing registration
Errors	ILLEGAL_STATE		`getOperation()`!= `UPDATE` and `getOperation()`!= `DROP`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	specifiesCreditOption
Description	Tests if this request item specifies the number of credits to be taken. If no credit option range is specified in the `RegistrationTarget`, then this may be left unspecified.
Return	`boolean`		`true` if this a credit option is specified, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditOption
Description	Gets the number of credits for which the student is registering.
Return	`decimal`		the number of credits
Errors	ILLEGAL_STATE		`specifiesCreditOption()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	specifiesGradingOption
Description	Tests if this request item specifies the grading option. If the `RegistrationTarget` does not specify multiple grading options, then this may be left unspecified.
Return	`boolean`		`true` if this a grading option is specified, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptionId
Description	Gets the grading option `Id`.
Return	`osid.id.Id`		the grading system `Id`
Errors	ILLEGAL_STATE		`specifiesGradingOption()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOption
Description	Gets the grading option.
Return	`osid.grading.GradeSystem`		the grade system option
Errors	ILLEGAL_STATE		`specifiesGradingOption()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemRecord
Description	Gets the registration request item record corresponding to the given `RegistrationR` equestItem record `Type`. This method ie used to retrieve an object implementing the requested record. The `registrationRequestItem` RecordType may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(registrationRequestItemRe` cordType) is `true`.
Parameters	`osid.type.Type`	`registrationRequestItemRecordType`	the type of registration request item record to retrieve
Return	`osid.course.registration.request.records.RegistrationRequestItemRecord`		the registration request item 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.