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

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

MethodgetProvisionables
Description

Gets the provisionable list resulting from a search.

Returnosid.provisioning.ProvisionableListthe provisionable list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableQueryInspector
Description

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

Returnosid.provisioning.ProvisionableQueryInspectorthe provisionable query inspector
CompliancemandatoryThis 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.TypeprovisionableSearchRecordTypea provisionable search record type
Returnosid.provisioning.records.ProvisionableSearchResultsRecordthe provisionable search results record
ErrorsNULL_ARGUMENT provisionableSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionableSearchRecordType) is false
CompliancemandatoryThis method must be implemented.