| Interface | osid.messaging.MessageSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getMessages | ||
| Description |
Gets the message list resulting from a search. | ||
| Return | osid.messaging.MessageList | the message list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.messaging.MessageQueryInspector | the message query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageSearchResultsRecord | ||
| Description |
Gets the message search results record corresponding to
the given message search record | ||
| Parameters | osid.type.Type | messageSearchRecordType | a message search record type |
| Return | osid.messaging.records.MessageSearchResultsRecord | the message 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. | |