| Interface | osid.provisioning.BrokerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 This interface provides a means to capture results of a search.  | ||
| Method | getBrokers | ||
| Description | 
                     Gets the broker list resulting from a search.  | ||
| Return | osid.provisioning.BrokerList | the broker list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.provisioning.BrokerQueryInspector | the broker query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerSearchResultsRecord | ||
| Description | 
                     Gets the broker search results record corresponding to 
                    the given broker search record   | ||
| Parameters | osid.type.Type | brokerSearchRecordType | a broker search record type | 
| Return | osid.provisioning.records.BrokerSearchResultsRecord | the broker search results record | |
| Errors | NULL_ARGUMENT |  brokerSearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(brokerSearchRecordType)  is  false 
  |                 ||
| Compliance | mandatory | This method must be implemented. | |