Interface MailboxSearchSession

All Superinterfaces:

AutoCloseable, Closeable, MailboxQuerySession, OsidSession, OsidSession

public interface MailboxSearchSession
extends MailboxQuerySession

This session provides methods for searching among Mailbox objects. The search query is constructed using the MailboxQuery.

getMailboxesByQuery() is the basic search method and returns a list of Mailbox objects.A more advanced search may be performed with getMailboxesBySearch().It accepts a MailboxSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getMailboxesBySearch() returns a MailboxSearchResults that can be used to access the resulting MailboxList or be used to perform a search within the result set through MailboxSearch.

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

Method Summary

Modifier and Type	Method	Description
MailboxSearchResults	getMailboxesBySearch(MailboxQuery mailboxQuery, MailboxSearch mailboxSearch)	Gets the search results matching the given search query using the given search.
MailboxQuery	getMailboxQueryFromInspector(MailboxQueryInspector mailboxQueryInspector)	Gets a mailbox query from an inspector.
MailboxSearch	getMailboxSearch()	Gets a mailbox search.
MailboxSearchOrder	getMailboxSearchOrder()	Gets a mailbox search order.

Methods inherited from interface Closeable

close

Methods inherited from interface MailboxQuerySession

canSearchMailboxes, getMailboxesByQuery, getMailboxQuery

Modifier and Type	Method	Description
boolean	canSearchMailboxes()	Tests if this user can perform Mailbox searches.
MailboxList	getMailboxesByQuery(MailboxQuery mailboxQuery)	Gets a list of Mailboxes matching the given mailbox query.
MailboxQuery	getMailboxQuery()	Gets a mailbox query.

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

getMailboxSearch

MailboxSearch getMailboxSearch()

Gets a mailbox search.

Returns:

the mailbox search

Compliance:

mandatory - This method must be implemented.

getMailboxSearchOrder

MailboxSearchOrder getMailboxSearchOrder()

Gets a mailbox search order. The MailboxSearchOrder is supplied to a MailboxSearch to specify the ordering of results.

Returns:

the mailbox search order

Compliance:

mandatory - This method must be implemented.

getMailboxesBySearch

MailboxSearchResults getMailboxesBySearch(MailboxQuery mailboxQuery,
 MailboxSearch mailboxSearch)
                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mailboxQuery - the mailbox query

mailboxSearch - the mailbox search

Returns:

the mailbox search results

Throws:

NullArgumentException - mailboxQuery or mailboxSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - mailboxQuery or mailboxSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getMailboxQueryFromInspector

MailboxQuery getMailboxQueryFromInspector(MailboxQueryInspector mailboxQueryInspector)

Gets a mailbox query from an inspector. The inspector is available from a MailboxSearchResults.

Parameters:

mailboxQueryInspector - a mailbox query inspector

Returns:

the mailbox query

Throws:

NullArgumentException - mailboxQueryInspector is null

UnsupportedException - mailboxQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.