Interface | osid.learning.ObjectiveBankSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getObjectiveBanks | ||
Description |
Gets the objective bank list resulting from the search. | ||
Return | osid.learning.ObjectiveBankList | the objective bank list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBankQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.learning.ObjectiveBankQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectiveBankSearchResultsRecord | ||
Description |
Gets the objective bank search results record
corresponding to the given objective bank search record
| ||
Parameters | osid.type.Type | objectiveBankSearchRecordType | an objective bank search record type |
Return | osid.learning.records.ObjectiveBankSearchResultsRecord | the objective bank search results record | |
Errors | NULL_ARGUMENT | objectiveBankSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasSearchRecordType(objective bankSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |