OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.ProvisionableSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.ProvisionableSearchSession
Description

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

MethodgetProvisionables
Description

Gets the provisionable list resulting from a search.

Returnosid.provisioning.ProvisionableList the provisionable list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetProvisionableQueryInspector
Description

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

Returnosid.provisioning.ProvisionableQueryInspector the provisionable query inspector
Compliancemandatory This method must be implemented.
MethodgetProvisionableSearchResultsRecord
Description

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

Parametersosid.type.TypeprovisionableSearchRecordType a provisionable search record type
Returnosid.provisioning.records.ProvisionableSearchResultsRecord the provisionable search results record
ErrorsNULL_ARGUMENT provisionableSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(provisionableSearchRecordType) is false
Compliancemandatory This method must be implemented.