Interface ReceiptMailboxSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ReceiptMailboxSession
extends OsidSession

This session provides methods to retrieve Receipt to Mailbox mappings. A Receipt 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

Like all OsidSessions, ReceiptMailboxSessions are dedicated to single processing threads and a single authenticated user.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupReceiptMailboxMappings()	Tests if this user can perform lookups of receipt/mailbox mappings.
MailboxList	getMailboxesByReceipt(Id messageId)	Gets the list of Mailbox objects mapped to a Receipt.
IdList	getMailboxIdsByReceipt(Id messageId)	Gets the list of Mailbox Ids mapped to a Receipt.
IdList	getReceiptIdsByMailbox(Id mailboxId)	Gets the list of Receipt Ids associated with a Mailbox.
IdList	getReceiptIdsByMailboxes(IdList mailboxIds)	Gets the list of Receipt Ids corresponding to a list of Mailbox objects.
ReceiptList	getReceiptsByMailbox(Id mailboxId)	Gets the list of Receipts associated with a Mailbox.
ReceiptList	getReceiptsByMailboxes(IdList mailboxIds)	Gets the list of Receipts 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 Receipt and Mailbox returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatTypes, getLocales, isAuthenticated, startTransaction, supportsTransactions

Method Details

canLookupReceiptMailboxMappings

boolean canLookupReceiptMailboxMappings()

Tests if this user can perform lookups of receipt/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 must be implemented.

usePlenaryMailboxView

void usePlenaryMailboxView()

A complete view of the Receipt 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 must be implemented.

getReceiptIdsByMailbox

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

Gets the list of Receipt Ids associated with a Mailbox.

Parameters:

mailboxId - Id of a Mailbox

Returns:

list of related receipt 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.

getReceiptsByMailbox

ReceiptList getReceiptsByMailbox(Id mailboxId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Receipts associated with a Mailbox.

Parameters:

mailboxId - Id of a Mailbox

Returns:

list of related receipts

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.

getReceiptIdsByMailboxes

IdList getReceiptIdsByMailboxes(IdList mailboxIds)
                         throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mailboxIds - list of mailbox Ids

Returns:

list of receipt Ids

Throws:

NullArgumentException - mailboxIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getReceiptsByMailboxes

ReceiptList getReceiptsByMailboxes(IdList mailboxIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

mailboxIds - list of mailbox Ids

Returns:

list of receipts

Throws:

NullArgumentException - mailboxIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMailboxIdsByReceipt

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

Gets the list of Mailbox Ids mapped to a Receipt.

Parameters:

messageId - Id of a Receipt

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.

getMailboxesByReceipt

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

Gets the list of Mailbox objects mapped to a Receipt.

Parameters:

messageId - Id of a Receipt

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.