OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.DistributorSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.DistributorSearchSession
Description

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

MethodgetDistributors
Description

Gets the distributor list resulting from a search.

Returnosid.provisioning.DistributorList the distributor list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetDistributorQueryInspector
Description

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

Returnosid.provisioning.DistributorQueryInspector the distributor query inspector
Compliancemandatory This method must be implemented.
MethodgetDistributorSearchResultsRecord
Description

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

Parametersosid.type.TypedistributorSearchRecordType a distributor search record type
Returnosid.provisioning.records.DistributorSearchResultsRecord the distributor search results record
ErrorsNULL_ARGUMENT distributorSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(distributorSearchRecordType) is false
Compliancemandatory This method must be implemented.