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

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

MethodgetQueueProcessors
Description

Gets the QueueProcessorList resulting from a search.

Returnosid.tracking.rules.QueueProcessorListthe queue processor list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorQueryInspector
Description

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

Returnosid.tracking.rules.QueueProcessorQueryInspectorthe queue processor query inspector
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorSearchResultsRecord
Description

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

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