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

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

MethodgetQueueConstrainerEnablers
Description

Gets the QueueConstrainerEnablerList resulting from a search.

Returnosid.provisioning.rules.QueueConstrainerEnablerListthe queue constrainer enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerQueryInspector
Description

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

Returnosid.provisioning.rules.QueueConstrainerEnablerQueryInspectorthe queue constrainer enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerSearchResultsRecord
Description

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

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