org.osid.messaging

Interface MailboxQuerySession

All Superinterfaces:

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

Methods

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

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.