| Interface | osid.provisioning.DistributorSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing distributor searches. | ||
| Method | searchAmongDistributors | ||
| Description |
Execute this search among the given list of distributors. | ||
| Parameters | osid.id.IdList | distributorIds | list of distributors |
| Errors | NULL_ARGUMENT | distributorIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDistributorResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.provisioning.DistributorSearchOrder | distributorSearchOrder | distributor search order |
| Errors | NULL_ARGUMENT | distributorSearchOrder is null | |
| UNSUPPORTED | distributorSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDistributorSearchRecord | ||
| Description |
Gets the distributor search record corresponding to the
given distributor search record | ||
| Parameters | osid.type.Type | distributorSearchRecordType | a distributor search record type |
| Return | osid.provisioning.records.DistributorSearchRecord | the distributor search record | |
| Errors | NULL_ARGUMENT | distributorSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(distributorSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |