org.osid.messaging

Interface MailboxNode

All Superinterfaces:

Containable, Identifiable, OsidNode

public interface MailboxNode
extends OsidNode

This interface is a container for a partial hierarchy retrieval. The number of hierarchy levels traversable through this interface depend on the number of levels requested in the MailboxHierarchySession.

Method Summary

Methods

Modifier and Type	Method and Description
MailboxNodeList	getChildMailboxNodes() Gets the children of this mailbox.
Mailbox	getMailbox() Gets the Mailbox at this node.
MailboxNodeList	getParentMailboxNodes() Gets the parents of this mailbox.

Methods inherited from interface org.osid.OsidNode

getChildIds, getParentIds, hasChildren, hasParents, isLeaf, isRoot

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Containable

isSequestered

Method Detail

getMailbox

Mailbox getMailbox()

Gets the Mailbox at this node.

Returns:

the mailbox represented by this node

Compliance:

mandatory - This method must be implemented.

getParentMailboxNodes

MailboxNodeList getParentMailboxNodes()

Gets the parents of this mailbox.

Returns:

the parents of this mailbox

Compliance:

mandatory - This method must be implemented.

getChildMailboxNodes

MailboxNodeList getChildMailboxNodes()

Gets the children of this mailbox.

Returns:

the children of this mailbox

Compliance:

mandatory - This method must be implemented.