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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchMailboxes()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. MailboxQuery getMailboxQuery()
mandatory
- This method must be implemented. MailboxList getMailboxesByQuery(MailboxQuery mailboxQuery) throws OperationFailedException, PermissionDeniedException
Mailboxes
matching the given mailbox
query.mailboxQuery
- the mailbox query MailboxList
NullArgumentException
- mailboxQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- a mailboxQuery
is
not of this servicemandatory
- This method must be implemented.