OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Interfaceosid.tracking.rules.QueueEnablerSearch
Implementsosid.OsidSearch
Used Byosid.tracking.rules.QueueEnablerSearchSession
Description

The search interface for governing queue enabler searches.

MethodsearchAmongQueueEnablers
Description

Execute this search among the given list of queue enablers.

Parametersosid.id.IdListqueueEnablerIdslist of queue enablers
ErrorsNULL_ARGUMENTqueueEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderQueueEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.tracking.rules.QueueEnablerSearchOrderqueueEnablerSearchOrderqueue enabler search order
ErrorsNULL_ARGUMENTqueueEnablerSearchOrder is null
UNSUPPORTEDqueueEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueEnablerSearchRecord
Description

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

Parametersosid.type.TypequeueEnablerSearchRecordTypea queue enabler search record type
Returnosid.tracking.rules.records.QueueEnablerSearchRecordthe queue enabler search record
ErrorsNULL_ARGUMENTqueueEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(queueEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.