OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.DispatchSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetDispatches
Description

Gets the dispatch list resulting from a search.

Returnosid.subscription.DispatchListthe dispatch list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetDispatchQueryInspector
Description

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

Returnosid.subscription.DispatchQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetDispatchSearchResultsRecord
Description

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

Parametersosid.type.TypedispatchSearchRecordTypea dispatch search record type
Returnosid.subscription.records.DispatchSearchResultsRecordthe dispatch search results record
ErrorsNULL_ARGUMENT DispatchSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(dispatchSearchRecordType) is false
CompliancemandatoryThis method must be implemented.