OSID Logo
OSID Specifications
provisioning package
Version 3.1.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.IdListqueueIds list of queues
ErrorsNULL_ARGUMENT queueIds is null
Compliancemandatory This method must be implemented.
MethodorderQueueResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.QueueSearchOrderqueueSearchOrder queue search order
ErrorsNULL_ARGUMENT queueSearchOrder is null
UNSUPPORTED queueSearchOrder is not of this service
Compliancemandatory This 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.TypequeueSearchRecordType a queue search record type
Returnosid.provisioning.records.QueueSearchRecord the queue search record
ErrorsNULL_ARGUMENT queueSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(queueSearchRecordType) is false
Compliancemandatory This method must be implemented.