OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Interfaceosid.tracking.rules.QueueEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.tracking.rules.QueueEnablerSearchSession
Description

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

MethodgetQueueEnablers
Description

Gets the queue enabler list resulting from a search.

Returnosid.tracking.rules.QueueEnablerListthe queue enabler list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetQueueEnablerQueryInspector
Description

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

Returnosid.tracking.rules.QueueEnablerQueryInspectorthe queue enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetQueueEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypequeueEnablerSearchRecordTypea queue enabler search record type
Returnosid.tracking.rules.records.QueueEnablerSearchResultsRecordthe queue enabler search results record
ErrorsNULL_ARGUMENTqueueEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(queueEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.