Interface | osid.learning.ProficiencySearchOrder | ||
---|---|---|---|
Implements | osid.OsidRelationshipSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByResource | ||
Description |
Specifies a preference for ordering the result set by the resource. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceSearchOrder | ||
Description |
Tests if a resource search order is available. | ||
Return | boolean | true if a resource search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceSearchOrder | ||
Description |
Gets a resource search order. | ||
Return | osid.resource.ResourceSearchOrder | a resource search order | |
Errors | UNIMPLEMENTED | supportsResourceSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsResourceSearchOrder()
is true. | |
Method | orderByObjective | ||
Description |
Specifies a preference for ordering the result set by the objective. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsObjectiveSearchOrder | ||
Description |
Tests if an objective search order is available. | ||
Return | boolean | true if an objective search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveSearchOrder | ||
Description |
Gets an objective search order. | ||
Return | osid.learning.ObjectiveSearchOrder | an objective search order | |
Errors | UNIMPLEMENTED | supportsObjectiveSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsObjectiveSearchOrder()
is true. | |
Method | orderByCompletion | ||
Description |
Specifies a preference for ordering the result set by the completion. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByLevel | ||
Description |
Specifies a preference for ordering the result set by the level. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLevelSearchOrder | ||
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 | getLevelSearchOrder | ||
Description |
Gets a grade search order. | ||
Return | osid.grading.GradeSearchOrder | a grade search order | |
Errors | UNIMPLEMENTED | supportsLevelSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsLevelSearchOrder()
is true. | |
Method | getProficiencySearchOrderRecord | ||
Description |
Gets the proficiency search order record corresponding
to the given proficiency record | ||
Parameters | osid.type.Type | proficiencyRecordType | a proficiency record type |
Return | osid.learning.records.ProficiencySearchOrderRecord | the proficiency search order record | |
Errors | NULL_ARGUMENT | proficiencyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(proficiencyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |