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

The search interface for governing provisionable searches.

MethodsearchAmongProvisionables
Description

Execute this search among the given list of provisionables.

Parametersosid.id.IdListprovisionableIdslist of provisionables
ErrorsNULL_ARGUMENT provisionableIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProvisionableResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.ProvisionableSearchOrderprovisionableSearchOrderprovisionable search order
ErrorsNULL_ARGUMENT provisionableSearchOrder is null
UNSUPPORTED provisionableSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableSearchRecord
Description

Gets the provisionable search 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.ProvisionableSearchRecordthe provisionable search interface
ErrorsNULL_ARGUMENT provisionableSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(provisionableSearchRecordType) is false
CompliancemandatoryThis method must be implemented.