OSID Logo
OSID Specifications
transport package
Version 3.1.0
Interfaceosid.transport.EndpointSearchResults
Implementsosid.OsidSearchResults
Used Byosid.transport.EndpointSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetEndpoints
Description

Gets the endpoint list resulting from the search.

Returnosid.transport.EndpointList the endpoint list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetEndpointQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.transport.EndpointQueryInspector the endpoint query inspector
Compliancemandatory This method must be implemented.
MethodgetEndpointSearchResultsRecord
Description

Gets the endpoint search results record corresponding to the given endpoint search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeendpointSearchRecordType a endpoint search record type
Returnosid.transport.records.EndpointSearchResultsRecord the endpoint search results record
ErrorsNULL_ARGUMENT endpointSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(endpointSearchRecordType) is false
Compliancemandatory This method must be implemented.