org.osid.messaging

Interface MailboxSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MailboxQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.messaging.MailboxQuerySession

canSearchMailboxes, getMailboxesByQuery, getMailboxQuery

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.