public interface MessageSearch extends OsidSearch
The search interface for governing message searches.
Modifier and Type | Method and Description |
---|---|
MessageSearchRecord |
getMessageSearchRecord(Type messageSearchRecordType)
Gets the message search record corresponding to the given message
search record
Type. |
void |
orderMessageResults(MessageSearchOrder messageSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongMessages(IdList messageIds)
Execute this search among the given list of messages.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongMessages(IdList messageIds)
messageIds
- list of message Ids
NullArgumentException
- messageIds
is
null
mandatory
- This method must be implemented. void orderMessageResults(MessageSearchOrder messageSearchOrder)
messageSearchOrder
- message search orderNullArgumentException
- messageSearchOrder
is null
UnsupportedException
- messageSearchOrder
is not of this servicemandatory
- This method must be implemented. MessageSearchRecord getMessageSearchRecord(Type messageSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.messageSearchRecordType
- a message search record typeNullArgumentException
- messageSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordTypeType(messageSearchRecordType)
is
false
mandatory
- This method must be implemented.