OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.DistributorSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetDistributors
Description

Gets the distributor list resulting from a search.

Returnosid.provisioning.DistributorListthe distributor list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDistributorQueryInspector
Description

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

Returnosid.provisioning.DistributorQueryInspectorthe distributor query inspector
CompliancemandatoryThis 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.TypedistributorSearchRecordTypea distributor search record type
Returnosid.provisioning.records.DistributorSearchResultsRecordthe distributor search results record
ErrorsNULL_ARGUMENT distributorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(distributorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.