Interface MessageSearchSession

All Superinterfaces:

AutoCloseable, Closeable, MessageQuerySession, OsidSession, OsidSession

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.

• federated mailbox view: searches include messages in mailboxes of which this mailbox is a ancestor in the mailbox hierarchy
• isolated mailbox view: searches are restricted to messages in this mailbox

Messages may have a query record indicated by their respective record types. The query record is accessed via the MessageQuery .

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface MessageQuerySession

canSearchMessages, getMailbox, getMailboxId, getMessageQuery, getMessagesByQuery, useFederatedMailboxView, useIsolatedMailboxView

Modifier and Type	Method	Description
boolean	canSearchMessages()	Tests if this user can perform Message searches.
Mailbox	getMailbox()	Gets the Mailbox associated with this session.
Id	getMailboxId()	Gets the Mailbox Id associated with this session.
MessageQuery	getMessageQuery()	Gets a message query.
MessageList	getMessagesByQuery(MessageQuery messageQuery)	Gets a list of Messages matching the given message query.
void	useFederatedMailboxView()	Federates the view for methods in this session.
void	useIsolatedMailboxView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getMessageSearch

MessageSearch getMessageSearch()

Gets a message search.

Returns:

the message search

Compliance:

mandatory - This method must be implemented.

getMessageSearchOrder

MessageSearchOrder getMessageSearchOrder()

Gets a message search order. The MessageSearchOrder is supplied to a MessageSearch to specify the ordering of results.

Returns:

the message search order

Compliance:

mandatory - This method must be implemented.

getMessagesBySearch

MessageSearchResults getMessagesBySearch(MessageQuery messageQuery,
 MessageSearch messageSearch)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

messageQuery - the message query

messageSearch - the message search

Returns:

the returned search results

Throws:

NullArgumentException - messageQuery or messageSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - messageQuery or messageSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getMessageQueryFromInspector

MessageQuery getMessageQueryFromInspector(MessageQueryInspector messageQueryInspector)

Gets a message query from an inspector. The inspector is available from a MessageSearchResults .

Parameters:

messageQueryInspector - a message query inspector

Returns:

the message query

Throws:

NullArgumentException - messageQueryInspector is null

UnsupportedException - messageQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.