| Interface | osid.messaging.ReceiptSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.messaging.ReceiptSearchSession | ||
| Description |
The search interface for governing receipt searches. | ||
| Method | searchAmongReceipts | ||
| Description |
Execute this search among the given list of receipts. | ||
| Parameters | osid.id.IdList | messageIds | list of receipt Ids |
| Errors | NULL_ARGUMENT | messageIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderReceiptResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.messaging.ReceiptSearchOrder | messageSearchOrder | receipt search order |
| Errors | NULL_ARGUMENT | messageSearchOrder is null | |
| UNSUPPORTED | messageSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceiptSearchRecord | ||
| Description |
Gets the receipt search record corresponding to the
given receipt search record | ||
| Parameters | osid.type.Type | messageSearchRecordType | a receipt search record type |
| Return | osid.messaging.records.ReceiptSearchRecord | the receipt search record | |
| Errors | NULL_ARGUMENT | messageSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordTypeType(messageSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |