OSID Logo
OSID Specifications
provisioning package
Version 3.1.0
Interfaceosid.provisioning.QueueSearchResults
Implementsosid.OsidSearchResults
Used Byosid.provisioning.QueueSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetQueues
Description

Gets the queue list resulting from a search.

Returnosid.provisioning.QueueList the queue list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetQueueQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.provisioning.QueueQueryInspector the queue query inspector
Compliancemandatory This method must be implemented.
MethodgetQueueSearchResultsRecord
Description

Gets the queue search results 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.QueueSearchResultsRecord the queue search results record
ErrorsNULL_ARGUMENT queueSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(queueSearchRecordType) is false
Compliancemandatory This method must be implemented.