OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.QueueSearch
Implementsosid.OsidSearch
Description

The search interface for governing queue searches.

MethodsearchAmongQueues
Description

Execute this search among the given list of queues.

Parametersosid.id.IdListqueueIdslist of queues
ErrorsNULL_ARGUMENT queueIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQueueResults
Description

Specify an ordering to the search results.

Parametersosid.tracking.QueueSearchOrderqueueSearchOrderqueue search order
ErrorsNULL_ARGUMENT queueSearchOrder is null
UNSUPPORTED queueSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueSearchRecord
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.QueueSearchRecordthe queue search record
ErrorsNULL_ARGUMENT queueSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.