| Interface | osid.transport.EndpointSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.transport.EndpointSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getEndpoints | ||
| Description |
Gets the endpoint list resulting from the search. | ||
| Return | osid.transport.EndpointList | the endpoint list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndpointQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.transport.EndpointQueryInspector | the endpoint query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEndpointSearchResultsRecord | ||
| Description |
Gets the endpoint search results record corresponding
to the given endpoint search record | ||
| Parameters | osid.type.Type | endpointSearchRecordType | a endpoint search record type |
| Return | osid.transport.records.EndpointSearchResultsRecord | the endpoint search results 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. | |