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

Interface	osid.course.program.ProgramOfferingSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByProgram
Description	Specifies a preference for ordering the result set by program.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramSearchOrder
Description	Tests if a course order is available.
Return	`boolean`		`true` if a course order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramSearchOrder
Description	Gets the course order.
Return	`osid.course.program.ProgramSearchOrder`		the program search order
Errors	UNIMPLEMENTED		`supportsProgramSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramSearchOrder()` is `true.`
Method	orderByTerm
Description	Specifies a preference for ordering the result set by term.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermSearchOrder
Description	Tests if a term order is available.
Return	`boolean`		`true` if a term order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTermSearchOrder
Description	Gets the term order.
Return	`osid.course.TermSearchOrder`		the term search order
Errors	UNIMPLEMENTED		`supportsTermSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTermSearchOrder()` is `true.`
Method	orderByTitle
Description	Specifies a preference for ordering the result set by program offering title.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByNumber
Description	Specifies a preference for ordering the result set by program offering number.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByCompletionRequirementsInfo
Description	Specifies a preference for ordering the result set by program completion requirements.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByRequiresRegistration
Description	Specifies a preference for ordering the result set by program offerings requiring registration.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMinimumSeats
Description	Specifies a preference for ordering the result set by the minimum seats.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByMaximumSeats
Description	Specifies a preference for ordering the result set by the maximum seats.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByURL
Description	Specifies a preference for ordering the result set by url.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingSearchOrderRecord
Description	Gets the program offering search order record corresponding to the given program offering record `Type.` Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`programOfferingRecordType`	a program offering record type
Return	`osid.course.program.records.ProgramOfferingSearchOrderRecord`		the program offering search order record
Errors	NULL_ARGUMENT		`programOfferingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programOfferingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.