Interface | osid.messaging.MessageSearchSession | ||
---|---|---|---|
Implements | osid.messaging.MessageQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Messages may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getMessageSearch | ||
Description |
Gets a message search. | ||
Return | osid.messaging.MessageSearch | the message search | |
Compliance | mandatory | This method must be implemented. | |
Method | getMessageSearchOrder | ||
Description |
Gets a message search order. The | ||
Return | osid.messaging.MessageSearchOrder | the message search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getMessagesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.messaging.MessageQuery | messageQuery | the message query |
osid.messaging.MessageSearch | messageSearch | the message search | |
Return | osid.messaging.MessageSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | messageQuery or messageSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | messageQuery or messageSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMessageQueryFromInspector | ||
Description |
Gets a message query from an inspector. The inspector
is available from a | ||
Parameters | osid.messaging.MessageQueryInspector | messageQueryInspector | a message query inspector |
Return | osid.messaging.MessageQuery | the message query | |
Errors | NULL_ARGUMENT | messageQueryInspector is null | |
UNSUPPORTED | messageQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |