OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Interfaceosid.tracking.rules.QueueConstrainerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.tracking.rules.QueueConstrainerSearchSession
Description

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

MethodgetQueueConstrainers
Description

Gets the QueueConstrainerList resulting from a search.

Returnosid.tracking.rules.QueueConstrainerListthe queue constrainer list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerQueryInspector
Description

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

Returnosid.tracking.rules.QueueConstrainerQueryInspectorthe queue constrainer query inspector
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerSearchResultsRecord
Description

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

Parametersosid.type.TypequeueConstrainerSearchRecordTypea queue constrainer search record type
Returnosid.tracking.rules.records.QueueConstrainerSearchResultsRecordthe queue constrainer search results record
ErrorsNULL_ARGUMENTqueueConstrainerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTEDhasRecordType(queueConstrainerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.