public interface MessageSearchSession extends MessageQuerySession
This session provides methods for searching among Message
objects. The search query is constructed using the
MessageQuery.
getMessagesByQuery()
is the basic search method and
returns a list of Messages.
A more advanced search may be
performed with getMessagesBySearch().
It accepts an
MessageSearch
in addition to the query for the purpose of
specifying additional options affecting the entire search, such as
ordering. getMessagesBySearch()
returns an
MessageSearchResults
that can be used to access the resulting
MessageList
or be used to perform a search within the
result set through MessageList.
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 MessageQuery.
Modifier and Type | Method and Description |
---|---|
MessageQuery |
getMessageQueryFromInspector(MessageQueryInspector messageQueryInspector)
Gets a message query from an inspector.
|
MessageSearchResults |
getMessagesBySearch(MessageQuery messageQuery,
MessageSearch messageSearch)
Gets the search results matching the given search query using the
given search.
|
MessageSearch |
getMessageSearch()
Gets a message search.
|
MessageSearchOrder |
getMessageSearchOrder()
Gets a message search order.
|
canSearchMessages, getMailbox, getMailboxId, getMessageQuery, getMessagesByQuery, useFederatedMailboxView, useIsolatedMailboxView
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
MessageSearch getMessageSearch()
mandatory
- This method must be implemented. MessageSearchOrder getMessageSearchOrder()
MessageSearchOrder
is
supplied to a MessageSearch
to specify the ordering of
results.mandatory
- This method must be implemented. MessageSearchResults getMessagesBySearch(MessageQuery messageQuery, MessageSearch messageSearch) throws OperationFailedException, PermissionDeniedException
messageQuery
- the message querymessageSearch
- the message searchNullArgumentException
- messageQuery
or
messageSearch
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- messageQuery
or
messageSearch
is not of this servicemandatory
- This method must be implemented. MessageQuery getMessageQueryFromInspector(MessageQueryInspector messageQueryInspector)
MessageSearchResults.
messageQueryInspector
- a message query inspectorNullArgumentException
- messageQueryInspector
is null
UnsupportedException
- messageQueryInspector
is not of this servicemandatory
- This method must be implemented.