OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Interfaceosid.provisioning.QueueSearch
Implementsosid.OsidSearch
Used Byosid.provisioning.QueueSearchSession
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_ARGUMENTqueueIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQueueResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.QueueSearchOrderqueueSearchOrderqueue search order
ErrorsNULL_ARGUMENTqueueSearchOrder is null
UNSUPPORTEDqueueSearchOrder 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.provisioning.records.QueueSearchRecordthe queue search record
ErrorsNULL_ARGUMENTqueueSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(queueSearchRecordType) is false
CompliancemandatoryThis method must be implemented.