| Interface | osid.messaging.MessageSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 The search interface for governing message searches.  | ||
| Method | searchAmongMessages | ||
| Description | 
                     Execute this search among the given list of messages.  | ||
| Parameters | osid.id.IdList | messageIds | list of message  Ids   | 
| Errors | NULL_ARGUMENT |  messageIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderMessageResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.messaging.MessageSearchOrder | messageSearchOrder | message search order | 
| Errors | NULL_ARGUMENT |  messageSearchOrder  is  null   |                 |
| UNSUPPORTED |  messageSearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getMessageSearchRecord | ||
| Description | 
                     Gets the message search record corresponding to the 
                    given message search record   | ||
| Parameters | osid.type.Type | messageSearchRecordType | a message search record type | 
| Return | osid.messaging.records.MessageSearchRecord | the message 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. | |