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

Modifier and Type	Method	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 Containable

isSequestered

Modifier and Type	Method	Description
boolean	isSequestered()	Tests if this Containable is sequestered in that it should not appear outside of its aggregated composition.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidNode

getChildIds, getParentIds, hasChildren, hasParents, isLeaf, isRoot

Modifier and Type	Method	Description
IdList	getChildIds()	Gets the children of this node.
IdList	getParentIds()	Gets the parents of this node.
boolean	hasChildren()	Tests if any children are available in this node structure.
boolean	hasParents()	Tests if any parents are available in this node structure.
boolean	isLeaf()	Tests if this node is a leaf in the hierarchy (has no children).
boolean	isRoot()	Tests if this node is a root in the hierarchy (has no parents).

Method Details

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.