Interface MailboxHierarchyDesignSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MailboxHierarchyDesignSession
extends OsidSession

This session defines methods for managing a hierarchy of Mailbox objects. Each node in the hierarchy is a unique Mailbox .

Method Summary

Modifier and Type	Method	Description
void	addChildMailbox(Id mailboxId, Id childId)	Adds a child to a mailbox.
void	addRootMailbox(Id mailboxId)	Adds a root mailbox.
boolean	canModifyMailboxHierarchy()	Tests if this user can change the hierarchy.
Hierarchy	getMailboxHierarchy()	Gets the hierarchy associated with this session.
Id	getMailboxHierarchyId()	Gets the hierarchy Id associated with this session.
void	removeChildMailbox(Id mailboxId, Id childId)	Removes a child from a mailbox.
void	removeChildMailboxes(Id mailboxId)	Removes all children from a mailbox.
void	removeRootMailbox(Id mailboxId)	Remove a root mailbox.

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

getMailboxHierarchyId

Id getMailboxHierarchyId()

Gets the hierarchy Id associated with this session.

Returns:

the hierarchy Id associated with this session

Compliance:

mandatory - This method must be implemented.

getMailboxHierarchy

Hierarchy getMailboxHierarchy()
                       throws OperationFailedException,
PermissionDeniedException

Gets the hierarchy associated with this session.

Returns:

the hierarchy associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canModifyMailboxHierarchy

boolean canModifyMailboxHierarchy()

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returns:

false if changing this hierarchy is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

addRootMailbox

void addRootMailbox(Id mailboxId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a root mailbox.

Parameters:

mailboxId - the Id of a mailbox

Throws:

AlreadyExistsException - mailboxId is already in hierarchy

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeRootMailbox

void removeRootMailbox(Id mailboxId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Remove a root mailbox.

Parameters:

mailboxId - the Id of a mailbox

Throws:

NotFoundException - mailboxId is not a root

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addChildMailbox

void addChildMailbox(Id mailboxId,
 Id childId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a child to a mailbox.

Parameters:

mailboxId - the Id of a mailbox

childId - the Id of the new child

Throws:

AlreadyExistsException - mailboxId is already a parent of childId

NotFoundException - mailboxId or childId not found

NullArgumentException - mailboxId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildMailbox

void removeChildMailbox(Id mailboxId,
 Id childId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a child from a mailbox.

Parameters:

mailboxId - the Id of a mailbox

childId - the Id of the new child

Throws:

NotFoundException - mailboxId not a parent of childId

NullArgumentException - mailboxId or childId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeChildMailboxes

void removeChildMailboxes(Id mailboxId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes all children from a mailbox.

Parameters:

mailboxId - the Id of a mailbox

Throws:

NotFoundException - mailboxId not found

NullArgumentException - mailboxId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.