Interface MailboxQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

MailboxSearchSession

public interface MailboxQuerySession
extends OsidSession

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

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
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 Closeable

close

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

canSearchMailboxes

boolean canSearchMailboxes()

Tests if this user can perform Mailbox searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getMailboxQuery

MailboxQuery getMailboxQuery()

Gets a mailbox query.

Returns:

the mailbox query

Compliance:

mandatory - This method must be implemented.

getMailboxesByQuery

MailboxList getMailboxesByQuery(MailboxQuery mailboxQuery)
                         throws OperationFailedException,
PermissionDeniedException

Gets a list of Mailboxes matching the given mailbox query.

Parameters:

mailboxQuery - the mailbox query

Returns:

the returned MailboxList

Throws:

NullArgumentException - mailboxQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - a mailboxQuery is not of this service

Compliance:

mandatory - This method must be implemented.