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

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

MethodgetPoolProcessorEnablers
Description

Gets the PoolProcessorEnablerList resulting from a search.

Returnosid.provisioning.rules.PoolProcessorEnablerListthe pool processor enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerQueryInspector
Description

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

Returnosid.provisioning.rules.PoolProcessorEnablerQueryInspectorthe pool processor enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorEnablerSearchResultsRecord
Description

Gets the pool processor enabler search results record corresponding to the given pool processor enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parametersosid.type.TypepoolProcessorEnablerSearchRecordTypea pool processor enabler search record type
Returnosid.provisioning.rules.records.PoolProcessorEnablerSearchResultsRecordthe pool processor enabler search results record
ErrorsNULL_ARGUMENT poolProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(poolProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.