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

Interface	osid.course.program.ProgramSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidOperableSearchOrder`
Used By	`osid.course.chronicle.AssessmentEntrySearchOrder`
	`osid.course.chronicle.AwardEntrySearchOrder`
	`osid.course.chronicle.CredentialEntrySearchOrder`
	`osid.course.chronicle.ProgramEntrySearchOrder`
	`osid.course.program.ProgramOfferingSearchOrder`
	`osid.course.program.ProgramSearchOrder`
	`osid.course.program.ProgramSearchSession`
	`osid.course.program.ProgramSmartCourseCatalogSession`
Description	An interface for specifying the ordering of search results.
Method	orderByTitle
Description	Specifies a preference for ordering the result set by program 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 number.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByParentProgram
Description	Specifies a preference for ordering the result set by parent program.
Parameters	`osid.SearchOrderStyle`	`style`	a search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsParentProgramSearchOrder
Description	Tests if a parent program search order is available.
Return	`boolean`		`true` if a program search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentProgramSearchOrder
Description	Gets the parent program search order.
Return	`osid.course.program.ProgramSearchOrder`		the program search order
Errors	UNIMPLEMENTED		`supportsParentProgramSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParentProgramSearchOrder()` is `true`.
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	getProgramSearchOrderRecord
Description	Gets the program search order record corresponding to the given program record `Type`. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`programRecordType`	a program record type
Return	`osid.course.program.records.ProgramSearchOrderRecord`		the program search order record
Errors	NULL_ARGUMENT		`programRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.