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

The search interface for governing queue processor enabler searches.

MethodsearchAmongQueueProcessorEnablers
Description

Execute this search among the given list of queue processor enablers.

Parametersosid.id.IdListqueueProcessorEnablerIdslist of queue processor enablers
ErrorsNULL_ARGUMENT queueProcessorEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQueueProcessorEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.tracking.rules.QueueProcessorEnablerSearchOrderqueueProcessorEnablerSearchOrderqueue processor enabler search order
ErrorsNULL_ARGUMENT queueProcessorEnablerSearchOrder is null
UNSUPPORTED queueProcessorEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorEnablerSearchRecord
Description

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

Parametersosid.type.TypequeueProcessorEnablerSearchRecordTypea queue processor enabler search record type
Returnosid.tracking.rules.records.QueueProcessorEnablerSearchRecordthe queue processor enabler search record
ErrorsNULL_ARGUMENT queueProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(queueProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.