OSID Logo
OSID Specifications
transport package
Version 3.1.0
Interfaceosid.transport.EndpointSearch
Implementsosid.OsidSearch
Used Byosid.transport.EndpointSearchSession
Description

The interface for governing endpoint searches.

MethodsearchAmongEndpoints
Description

Execute this search among the given list of endpoints.

Parametersosid.id.IdListendpointIds list of endpoints
ErrorsNULL_ARGUMENT endpointIds is null
Compliancemandatory This method must be implemented.
MethodorderEndpointResults
Description

Specify an ordering to the search results.

Parametersosid.transport.EndpointSearchOrderendpointSearchOrder endpoint search order
ErrorsNULL_ARGUMENT endpointSearchOrder is null
UNSUPPORTED endpointSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetEndpointSearchRecord
Description

Gets the endpoint search 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.EndpointSearchRecord the endpoint search record
ErrorsNULL_ARGUMENT endpointSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(endpointSearchRecordType) is false
Compliancemandatory This method must be implemented.