OSID - osid.course.syllabus.DocetSearchOrder Service Interface Definition

Interface	osid.course.syllabus.DocetSearchOrder
Implements	`osid.OsidRelationshipSearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByModule
Description	Specified a preference for ordering results by the module.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsModuleSearchOrder
Description	Tests if a `ModuleSearchOrder` is available.
Return	`boolean`		`true` if a module search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getModuleSearchOrder
Description	Gets the search order for a module.
Return	`osid.course.syllabus.ModuleSearchOrder`		the module search order
Errors	UNIMPLEMENTED		`supportsModuleSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModuleSearchOrder()` is `true.`
Method	orderByActivityUnit
Description	Specified a preference for ordering results by the activity unit.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitSearchOrder
Description	Tests if an `ActivityUnitSearchOrder` is available.
Return	`boolean`		`true` if an activity unit search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitSearchOrder
Description	Gets the search order for an actvity unit.
Return	`osid.course.ActivityUnitSearchOrder`		the activity unit search order
Errors	UNIMPLEMENTED		`supportsActivityUnitSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityUnitSearchOrder()` is `true.`
Method	orderByInClass
Description	Specified a preference for ordering results by the in class flag.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	orderByDuration
Description	Specified a preference for ordering results by the duration.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDocetSearchOrderRecord
Description	Gets the docet search order record corresponding to the given docet record Type. Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`docetRecordType`	a docet record type
Return	`osid.course.syllabus.records.DocetSearchOrderRecord`		the docet search order record
Errors	NULL_ARGUMENT		`docetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(docetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.