OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.ReceiptSearch
Implementsosid.OsidSearch
Used Byosid.messaging.ReceiptSearchSession
Description

The search interface for governing receipt searches.

MethodsearchAmongReceipts
Description

Execute this search among the given list of receipts.

Parametersosid.id.IdListmessageIds list of receipt Ids
ErrorsNULL_ARGUMENT messageIds is null
Compliancemandatory This method must be implemented.
MethodorderReceiptResults
Description

Specify an ordering to the search results.

Parametersosid.messaging.ReceiptSearchOrdermessageSearchOrder receipt search order
ErrorsNULL_ARGUMENT messageSearchOrder is null
UNSUPPORTED messageSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetReceiptSearchRecord
Description

Gets the receipt search 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.ReceiptSearchRecord the receipt search record
ErrorsNULL_ARGUMENT messageSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordTypeType(messageSearchRecordType) is false
Compliancemandatory This method must be implemented.