| Interface | osid.resource.BinSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getBins | ||
| Description |
Gets the bin list resulting from the search. | ||
| Return | osid.resource.BinList | the bin list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.resource.BinQueryInspector | the bin query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBinSearchResultsRecord | ||
| Description |
Gets the bin search results record corresponding to the
given bin search record | ||
| Parameters | osid.type.Type | binSearchRecordType | a bin search record type |
| Return | osid.resource.records.BinSearchResultsRecord | the bin search results record | |
| Errors | NULL_ARGUMENT | binSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(binSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |