Interface | osid.assessment.BankSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getBanks | ||
Description |
Gets the bank list resulting from a search. | ||
Return | osid.assessment.BankList | the bank list | |
Errors | ILLEGAL_STATE | the bank list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.assessment.BankQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getBankSearchResultsRecord | ||
Description |
Gets the bank search results record corresponding to
the given bank search record | ||
Parameters | osid.type.Type | bankSearchRecordType | a bank search record type |
Return | osid.assessment.records.BankSearchResultsRecord | the bank search results record | |
Errors | NULL_ARGUMENT | bankSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(bankSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |