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

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

MethodgetPools
Description

Gets the pool list resulting from a search.

Returnosid.provisioning.PoolListthe pool list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPoolQueryInspector
Description

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

Returnosid.provisioning.PoolQueryInspectorthe pool query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPoolSearchResultsRecord
Description

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

Parametersosid.type.TypepoolSearchRecordTypea pool search record type
Returnosid.provisioning.records.PoolSearchResultsRecordthe pool search results record
ErrorsNULL_ARGUMENT poolSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolSearchRecordType) is false
CompliancemandatoryThis method must be implemented.