Interface MessageMailboxSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MessageMailboxSession
extends OsidSession

This session provides methods to retrieve Message to Mailbox mappings. A Message may appear in multiple Mailboxes . Each Mailbox may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupMessageMailboxMappings()	Tests if this user can perform lookups of message/mailbox mappings.
MailboxList	getMailboxesByMessage(Id messageId)	Gets the list of Mailbox objects mapped to a Message .
IdList	getMailboxIdsByMessage(Id messageId)	Gets the list of Mailbox Ids mapped to a Message .
IdList	getMessageIdsByMailbox(Id mailboxId)	Gets the list of Message Ids associated with a Mailbox .
IdList	getMessageIdsByMailboxes(IdList mailboxIds)	Gets the list of Message Ids corresponding to a list of Mailbox objects.
MessageList	getMessagesByMailbox(Id mailboxId)	Gets the list of Messages associated with a Mailbox .
MessageList	getMessagesByMailboxes(IdList mailboxIds)	Gets the list of Messages corresponding to a list of Mailboxes .
void	useComparativeMailboxView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryMailboxView()	A complete view of the Message and Mailbox returns is desired.

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

canLookupMessageMailboxMappings

boolean canLookupMessageMailboxMappings()

Tests if this user can perform lookups of message/mailbox mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeMailboxView

void useComparativeMailboxView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryMailboxView

void usePlenaryMailboxView()

A complete view of the Message and Mailbox returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getMessageIdsByMailbox

IdList getMessageIdsByMailbox(Id mailboxId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Message Ids associated with a Mailbox .

Parameters:

mailboxId - Id of a Mailbox

Returns:

list of related message Ids

Throws:

NotFoundException - mailboxId is not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMessagesByMailbox

MessageList getMessagesByMailbox(Id mailboxId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Messages associated with a Mailbox .

Parameters:

mailboxId - Id of a Mailbox

Returns:

list of related messages

Throws:

NotFoundException - mailboxId is not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMessageIdsByMailboxes

IdList getMessageIdsByMailboxes(IdList mailboxIds)
                         throws OperationFailedException,
PermissionDeniedException

Gets the list of Message Ids corresponding to a list of Mailbox objects.

Parameters:

mailboxIds - list of mailbox Ids

Returns:

list of message Ids

Throws:

NullArgumentException - mailboxIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMessagesByMailboxes

MessageList getMessagesByMailboxes(IdList mailboxIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of Messages corresponding to a list of Mailboxes .

Parameters:

mailboxIds - list of mailbox Ids

Returns:

list of messages

Throws:

NullArgumentException - mailboxIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMailboxIdsByMessage

IdList getMailboxIdsByMessage(Id messageId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Mailbox Ids mapped to a Message .

Parameters:

messageId - Id of a Message

Returns:

list of mailbox Ids

Throws:

NotFoundException - messageId is not found

NullArgumentException - messageId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMailboxesByMessage

MailboxList getMailboxesByMessage(Id messageId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Mailbox objects mapped to a Message .

Parameters:

messageId - Id of a Message

Returns:

list of mailboxes

Throws:

NotFoundException - messageId is not found

NullArgumentException - messageId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.