OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetQueueProcessorEnablers
Description

Gets the QueueProcessorEnablerList resulting from a search.

Returnosid.tracking.rules.QueueProcessorEnablerListthe queue processor enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerQueryInspector
Description

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

Returnosid.tracking.rules.QueueProcessorEnablerQueryInspectorthe queue processor enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypequeueProcessorEnablerSearchRecordTypea queue processor enabler search record type
Returnosid.tracking.rules.records.QueueProcessorEnablerSearchResultsRecordthe queue processor enabler search results record
ErrorsNULL_ARGUMENT queueProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(queueProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.