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

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

MethodgetPoolConstrainerEnablers
Description

Gets the PoolConstrainerEnablerList resulting from a search.

Returnosid.provisioning.rules.PoolConstrainerEnablerListthe pool constrainer enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerQueryInspector
Description

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

Returnosid.provisioning.rules.PoolConstrainerEnablerQueryInspectorthe pool constrainer enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerEnablerSearchResultsRecord
Description

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

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