OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueProcessorSearch
Implementsosid.OsidSearch
Description

The search interface for governing queue processor searches.

MethodsearchAmongQueueProcessors
Description

Execute this search among the given list of queue processors.

Parametersosid.id.IdListdistributorIdslist of queue processors
ErrorsNULL_ARGUMENT distributorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQueueProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.provisioning.rules.QueueProcessorSearchOrderqueueProcessorSearchOrderqueue processor search order
ErrorsNULL_ARGUMENT queueProcessorSearchOrder is null
UNSUPPORTED queueProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorSearchRecord
Description

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

Parametersosid.type.TypequeueProcessorSearchRecordTypea queue processor search record type
Returnosid.provisioning.rules.records.QueueProcessorSearchRecordthe queue processor search record
ErrorsNULL_ARGUMENT queueProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.