| Interface | osid.provisioning.BrokerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing broker searches. | ||
| Method | searchAmongBrokers | ||
| Description |
Execute this search among the given list of brokers. | ||
| Parameters | osid.id.IdList | brokerIds | list of brokers |
| Errors | NULL_ARGUMENT | brokerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBrokerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.provisioning.BrokerSearchOrder | brokerSearchOrder | broker search order |
| Errors | NULL_ARGUMENT | brokerSearchOrder is null | |
| UNSUPPORTED | brokerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBrokerSearchRecord | ||
| Description |
Gets the broker search record corresponding to the
given broker search record | ||
| Parameters | osid.type.Type | brokerSearchRecordType | a broker search record type |
| Return | osid.provisioning.records.BrokerSearchRecord | the broker search 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. | |