OSID Logo
OSID Specifications
tracking rules package
Version 3.1.0
Interfaceosid.tracking.rules.QueueProcessorSearchResults
Implementsosid.OsidSearchResults
Used Byosid.tracking.rules.QueueProcessorSearchSession
Description

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

MethodgetQueueProcessors
Description

Gets the QueueProcessorList resulting from a search.

Returnosid.tracking.rules.QueueProcessorList the queue processor list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetQueueProcessorQueryInspector
Description

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

Returnosid.tracking.rules.QueueProcessorQueryInspector the queue processor query inspector
Compliancemandatory This 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.TypequeueProcessorSearchRecordType a queue processor search record type
Returnosid.tracking.rules.records.QueueProcessorSearchResultsRecord the queue processor search results record
ErrorsNULL_ARGUMENT queueProcessorSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(queueProcessorSearchRecordType) is false
Compliancemandatory This method must be implemented.