OSID - osid.learning.ObjectiveSearchOrder Service Interface Definition

Interface	osid.learning.ObjectiveSearchOrder
Implements	`osid.OsidObjectSearchOrder`
Implements	`osid.OsidFederateableSearchOrder`
Used By	`osid.learning.ActivitySearchOrder`
	`osid.learning.ObjectiveSearchSession`
	`osid.learning.ObjectiveSmartObjectiveBankSession`
	`osid.learning.ProficiencySearchOrder`
Description	An interface for specifying the ordering of search results.
Method	orderByAssessment
Description	Specified a preference for ordering results by the assessment.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentSearchOrder
Description	Tests if an `AssessmentSearchOrder` is available.
Return	`boolean`		`true` if an assessment search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentSearchOrder
Description	Gets the search order for an assessment.
Return	`osid.assessment.AssessmentSearchOrder`		the assessment search order
Errors	UNIMPLEMENTED		`supportsAssessmentSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentSearchOrder()` is `true`.
Method	orderByKnowledgeCategory
Description	Specifies a preference for ordering the result set by the knowledge category.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsKnowledgeCategorySearchOrder
Description	Tests if a grade search order is available.
Return	`boolean`		`true` if a grade search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getKnowledgeCategorySearchOrder
Description	Gets a grade search order to order on knolwgedge category.
Return	`osid.grading.GradeSearchOrder`		a grade search order
Errors	UNIMPLEMENTED		`supportsKnowledgeCategorySearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsKnowledgeCategorySearchOrder()` is `true`.
Method	orderByCognitiveProcess
Description	Specifies a preference for ordering the result set by the cognitive process.
Parameters	`osid.SearchOrderStyle`	`style`	search order style
Errors	NULL_ARGUMENT		`style` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	supportsCognitiveProcessSearchOrder
Description	Tests if a grade search order is available.
Return	`boolean`		`true` if a grade search order is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCognitiveProcessSearchOrder
Description	Gets a grade search order to order on cognitive process.
Return	`osid.grading.GradeSearchOrder`		a grade search order
Errors	UNIMPLEMENTED		`supportsCognitiveProcessSearchOrder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCognitiveProcessSearchOrder()` is `true`.
Method	getObjectiveSearchOrderRecord
Description	Gets the objective search order record corresponding to the given objective record `Type`.Multiple retrievals return the same underlying object.
Parameters	`osid.type.Type`	`objectiveRecordType`	an objective record type
Return	`osid.learning.records.ObjectiveSearchOrderRecord`		the objective search order record
Errors	NULL_ARGUMENT		`objectiveRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(objectiveRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.