OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.ReceiptSearchResults
Implementsosid.OsidSearchResults
Used Byosid.messaging.ReceiptSearchSession
Description

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

MethodgetReceipts
Description

Gets the receipt list resulting from a search.

Returnosid.messaging.ReceiptList the receipt list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetReceiptQueryInspector
Description

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

Returnosid.messaging.ReceiptQueryInspector the receipt query inspector
Compliancemandatory This method must be implemented.
MethodgetReceiptSearchResultsRecord
Description

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

Parametersosid.type.TypemessageSearchRecordType a receipt search record type
Returnosid.messaging.records.ReceiptSearchResultsRecord the receipt search results record
ErrorsNULL_ARGUMENT messageSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(messageSearchRecordType) is false
Compliancemandatory This method must be implemented.