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

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

MethodgetPoolConstrainers
Description

Gets the PoolConstrainerList resulting from a search.

Returnosid.provisioning.rules.PoolConstrainerListthe pool constrainer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerQueryInspector
Description

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

Returnosid.provisioning.rules.PoolConstrainerQueryInspectorthe pool constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetPoolConstrainerSearchResultsRecord
Description

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

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