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

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

MethodgetQueues
Description

Gets the queue list resulting from a search.

Returnosid.tracking.QueueListthe queue list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetQueueQueryInspector
Description

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

Returnosid.tracking.QueueQueryInspectorthe queue query inspector
CompliancemandatoryThis method must be implemented.
MethodgetQueueSearchResultsRecord
Description

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

Parametersosid.type.TypequeueSearchRecordTypea queue search record type
Returnosid.tracking.records.QueueSearchResultsRecordthe queue search results record
ErrorsNULL_ARGUMENT queueSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.