OSID - osid.course.registration.RegistrationSearchOrder Service Interface Definition

Interface	osid.course.registration.RegistrationSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.registration.RegistrationSearchSession`
Used By	`osid.course.registration.RegistrationSmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByCourseRegistration
Description	Specifies a preference for ordering the result set by course registration.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationSearchOrder
Description	Tests if a course registration search order is available.
Return	`boolean`		`true` if a course registration search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationSearchOrder
Description	Gets the course registration search order.
Return	`osid.course.registration.CourseRegistrationSearchOrder`		the course registration search order
Errors	UNIMPLEMENTED		`supportsCourseRegistrationSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseRegistrationSearchOrder()` is `true`.
Method	orderByRegistrationTarget
Description	Specifies a preference for ordering the result set by registration target.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetSearchOrder
Description	Tests if a registration target search order is available.
Return	`boolean`		`true` if a registration target search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetSearchOrder
Description	Gets the registration target search order.
Return	`osid.course.registration.RegistrationTargetSearchOrder`		the registration target search order
Errors	UNIMPLEMENTED		`supportsRegistrationTargetSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationTargetSearchOrder()` is `true`.
Method	orderByStudent
Description	Specifies a preference for ordering the result set by student.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentSearchOrder
Description	Tests if a student search order is available.
Return	`boolean`		`true` if a student search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentSearchOrder
Description	Gets the student search order.
Return	`osid.resource.ResourceSearchOrder`		the student search order
Errors	UNIMPLEMENTED		`supportsStudentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentSearchOrder()` is `true`.
Method	orderByGradingOption
Description	Specifies a preference for ordering the result set by the grading option.
Parameters	`osid.SearchOrderStyle`	`style`	a 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 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	UNIMPLEMENTED		`supportsGradingOptionSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradingOptionSearchOrder()` is `true`.
Method	getRegistrationSearchOrderRecord
Description	Gets the registration search order record corresponding to the given registration record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`registrationRecordType`	a registration record type
Return	`osid.course.registration.records.RegistrationSearchOrderRecord`		the registration search order record
Errors	NULL_ARGUMENT		`registrationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.