OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.DistributorSearch
Implementsosid.OsidSearch
Description

The search interface for governing distributor searches.

MethodsearchAmongDistributors
Description

Execute this search among the given list of distributors.

Parametersosid.id.IdListdistributorIdslist of distributors
ErrorsNULL_ARGUMENT distributorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDistributorResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.DistributorSearchOrderdistributorSearchOrderdistributor search order
ErrorsNULL_ARGUMENT distributorSearchOrder is null
UNSUPPORTED distributorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDistributorSearchRecord
Description

Gets the distributor search 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.DistributorSearchRecordthe distributor search record
ErrorsNULL_ARGUMENT distributorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(distributorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.