| Interface | osid.transport.EndpointSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.transport.EndpointSearchSession | ||
| Description |
The interface for governing endpoint searches. | ||
| Method | searchAmongEndpoints | ||
| Description |
Execute this search among the given list of endpoints. | ||
| Parameters | osid.id.IdList | endpointIds | list of endpoints |
| Errors | NULL_ARGUMENT | endpointIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderEndpointResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.transport.EndpointSearchOrder | endpointSearchOrder | endpoint search order |
| Errors | NULL_ARGUMENT | endpointSearchOrder is null | |
| UNSUPPORTED | endpointSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndpointSearchRecord | ||
| Description |
Gets the endpoint search record corresponding to the
given endpoint search record | ||
| Parameters | osid.type.Type | endpointSearchRecordType | a endpoint search record type |
| Return | osid.transport.records.EndpointSearchRecord | the endpoint search record | |
| Errors | NULL_ARGUMENT | endpointSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(endpointSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |