| Interface | osid.messaging.ReceiptSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.messaging.ReceiptSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getReceipts | ||
| Description |
Gets the receipt list resulting from a search. | ||
| Return | osid.messaging.ReceiptList | the receipt list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceiptQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.messaging.ReceiptQueryInspector | the receipt query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getReceiptSearchResultsRecord | ||
| Description |
Gets the receipt search results record corresponding
to the given receipt search record | ||
| Parameters | osid.type.Type | messageSearchRecordType | a receipt search record type |
| Return | osid.messaging.records.ReceiptSearchResultsRecord | the receipt search results 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. | |