public interface MessageQuerySession extends OsidSession
This session provides methods for searching among Message
objects. The search query is constructed using the
MessageQuery.
This session defines views that offer differing behaviors for searching.
Messages may have a query record indicated by their respective record
types. The query record is accessed via the MessageQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchMessages()
Tests if this user can perform
Message searches. |
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.
|
MessageList |
getMessagesByQuery(MessageQuery messageQuery)
Gets a list of
Messages matching the given message
query. |
void |
useFederatedMailboxView()
Federates the view for methods in this session.
|
void |
useIsolatedMailboxView()
Isolates the view for methods in this session.
|
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 canSearchMessages()
Message
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. void useFederatedMailboxView()
mandatory
- This method is must be implemented. void useIsolatedMailboxView()
mandatory
- This method is must be implemented. MessageQuery getMessageQuery()
mandatory
- This method must be implemented. MessageList getMessagesByQuery(MessageQuery messageQuery) throws OperationFailedException, PermissionDeniedException
Messages
matching the given message
query.messageQuery
- the message query MessageList
NullArgumentException
- messageQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- messageQuery
is
not of this servicemandatory
- This method must be implemented.