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

Interface	osid.course.program.EnrollmentSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Used By	`osid.course.program.EnrollmentSearchSession`
Used By	`osid.course.program.EnrollmentSmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByProgramOffering
Description	Specifies a preference for ordering the result set by program offering.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingSearchOrder
Description	Tests if a program offering search order is available.
Return	`boolean`		`true` if a program offering order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingSearchOrder
Description	Gets the program offering search order.
Return	`osid.course.program.ProgramOfferingSearchOrder`		the program offering search order
Errors	UNIMPLEMENTED		`supportsProgramOfferingSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramOfferingSearchOrder()` 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 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	getEnrollmentSearchOrderRecord
Description	Gets the enrollment search order record corresponding to the given enrollment record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`enrollmentRecordType`	an enrollment record type
Return	`osid.course.program.records.EnrollmentSearchOrderRecord`		the enrollment search order 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.