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

Interface	osid.course.registration.request.RegistrationRequestItemSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidSubjugateableSearchOrder`
Used By	`osid.course.registration.request.RegistrationRequestItemSearchSession`
Used By	`osid.course.registration.request.RegistrationRequestItemSmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByRegistrationRequest
Description	Orders the results by registration request.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationRequestSearchOrder
Description	Tests if a registration request search order is available.
Return	`boolean`		`true` if a registration request search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestSearchOrder
Description	Gets the registration request search order.
Return	`osid.course.registration.request.RegistrationRequestSearchOrder`		the registration request search order
Errors	ILLEGAL_STATE		`supportsRegistrationRequestSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByStudent
Description	Orders the results by student.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentSearchOrder
Description	Tests if a student resource search order is available.
Return	`boolean`		`true` if a student resource search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentSearchOrder
Description	Gets the resource search order.
Return	`osid.resource.ResourceSearchOrder`		the resource search order
Errors	ILLEGAL_STATE		`supportsStudentSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRegistrationOperation
Description	Orders the results by registration operation.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByExistingRegistration
Description	Orders the results by existing registration.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsExistingRegistrationSearchOrder
Description	Tests if an existing registration search order is available.
Return	`boolean`		`true` if an existing registration search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExistingRegistrationSearchOrder
Description	Gets the registration search order.
Return	`osid.course.registration.Registration`		the registration search order
Errors	ILLEGAL_STATE		`supportsExistingRegistrationSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCreditOption
Description	Orders the results by credit option.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByGradingOption
Description	Orders the results by grading option.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradingOptionSearchOrder
Description	Tests if a grade system search order is available.
Return	`boolean`		`true` if a grade system search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptionSearchOrder
Description	Gets the grade system search order.
Return	`osid.grading.GradeSystemSearchOrder`		the grade system search order
Errors	ILLEGAL_STATE		`supportsGradingOptionSearchOrder()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemSearchOrderRecord
Description	Gets the registration request item search order record corresponding to the given registration request item record `Type` . Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`registrationRequestItemRecordType`	a registration request item record type
Return	`osid.course.registration.request.records.RegistrationRequestItemSearchOrderRecord`		the registration request item search order 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.