| Interface | osid.learning.ProficiencySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProficiencies | ||
| Description |
Gets the proficiency list resulting from a search. | ||
| Return | osid.learning.ProficiencyList | the proficiency list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProficiencyQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.learning.ProficiencyQueryInspector | the proficiency query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProficiencySearchResultsRecord | ||
| Description |
Gets the proficiency search results record
corresponding to the given proficiency search record
| ||
| Parameters | osid.type.Type | proficiencySearchRecordType | a proficiency search record type |
| Return | osid.learning.records.ProficiencySearchResultsRecord | the proficiency search results record | |
| Errors | NULL_ARGUMENT | proficiencySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(proficiencySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |