public interface MessageSmartMailboxSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A MessageQuery
can be retrieved from this session
and mapped to this Map
to create a virtual collection of
Messages.
The messages may be sequenced using the
MessageSearchOrder
from this session.
This Mailbox
has a default query that matches any
message and a default search order that specifies no sequencing. The
queries may be examined using a MessageQueryInspector.
The
query may be modified by converting the inspector back to a
MessageQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyMessageQuery(MessageQuery messageQuery)
Applies a message query to this mailbox.
|
void |
applyMessageSequencing(MessageSearchOrder messageSearchOrder)
Applies a message search order to this mailbox.
|
boolean |
canManageSmartMailboxes()
Tests if this user can manage smart mailboxes.
|
Mailbox |
getMailbox()
Gets the
Mailbox associated with this session. |
Id |
getMailboxId()
Gets the
Mailbox Id associated with this
session. |
MessageQuery |
getMessageQuery()
Gets a message query.
|
MessageQuery |
getMessageQueryFromInspector(MessageQueryInspector messageQueryInspector)
Gets a message query from an inspector.
|
MessageSearchOrder |
getMessageSearchOrder()
Gets a message search order.
|
MessageQueryInspector |
inspecMessageQuery()
Gets a message query inspector for this mailbox.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getMailboxId()
Mailbox
Id
associated with this
session. Mailbox Id
associated with this sessionmandatory
- This method must be implemented. Mailbox getMailbox() throws OperationFailedException, PermissionDeniedException
Mailbox
associated with this session. Mailbox
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartMailboxes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart mailbox management is not
authorized, true
otherwisemandatory
- This method must be implemented. MessageQuery getMessageQuery()
mandatory
- This method must be implemented. MessageSearchOrder getMessageSearchOrder()
mandatory
- This method must be implemented. void applyMessageQuery(MessageQuery messageQuery) throws OperationFailedException, PermissionDeniedException
messageQuery
- the message queryNullArgumentException
- messageQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- messageQuery
not
of this servicemandatory
- This method must be implemented. MessageQueryInspector inspecMessageQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyMessageSequencing(MessageSearchOrder messageSearchOrder) throws OperationFailedException, PermissionDeniedException
messageSearchOrder
- the message search orderNullArgumentException
- messageSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- messageSearchOrder
not of this servicemandatory
- This method must be implemented. MessageQuery getMessageQueryFromInspector(MessageQueryInspector messageQueryInspector)
messageQueryInspector
- a message query inspectorNullArgumentException
- messageQueryInspector
is null
UnsupportedException
- messageQueryInspector
is not of this servicemandatory
- This method must be implemented.