org.osid.messaging

Interface MailboxReceiver

All Superinterfaces:

OsidReceiver

public interface MailboxReceiver
extends OsidReceiver

The mailbox receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Mailbox objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	changedMailboxes(IdList mailboxIds) The callback for notification of updated mailboxes.
void	deletedAncestorMailbox(Id mailboxId, Id ancestorId) The callback for notifications of deleted mailbox ancestors.
void	deletedDescendantMailbox(Id mailboxId, Id descendantId) The callback for notifications of deleted mailbox descendants.
void	deletedMailboxes(IdList mailboxIds) The callback for notification of deleted mailboxes.
void	newAncestorMailbox(Id mailboxId, Id ancestorId) The callback for notifications of new mailbox ancestors.
void	newDescendantMailbox(Id mailboxId, Id descendantId) The callback for notifications of new mailbox descendants.
void	newMailboxes(IdList mailboxIds) The callback for notifications of new mailboxes.
void	restructuredMailboxHierarchy() The callback for notifications of changes to a mailbox hierarchy where the hierarchy needs to refreshed.

Methods inherited from interface org.osid.OsidReceiver

down, up

Method Detail

newMailboxes

void newMailboxes(IdList mailboxIds)

The callback for notifications of new mailboxes.

Parameters:

mailboxIds - the Ids of the new Mailboxes

Compliance:

mandatory - This method must be implemented.

newAncestorMailbox

void newAncestorMailbox(Id mailboxId,
                      Id ancestorId)

The callback for notifications of new mailbox ancestors.

Parameters:

mailboxId - the Id of the Mailbox

ancestorId - the Id of the new Mailbox ancestor

Compliance:

mandatory - This method must be implemented.

newDescendantMailbox

void newDescendantMailbox(Id mailboxId,
                        Id descendantId)

The callback for notifications of new mailbox descendants.

Parameters:

mailboxId - the Id of the Mailbox

descendantId - the Id of the new Mailbox descendant

Compliance:

mandatory - This method must be implemented.

changedMailboxes

void changedMailboxes(IdList mailboxIds)

The callback for notification of updated mailboxes.

Parameters:

mailboxIds - the Ids of the updated Mailboxes

Compliance:

mandatory - This method must be implemented.

deletedMailboxes

void deletedMailboxes(IdList mailboxIds)

The callback for notification of deleted mailboxes.

Parameters:

mailboxIds - the Ids of the deleted Mailboxes

Compliance:

mandatory - This method must be implemented.

deletedAncestorMailbox

void deletedAncestorMailbox(Id mailboxId,
                          Id ancestorId)

The callback for notifications of deleted mailbox ancestors.

Parameters:

mailboxId - the Id of the Mailbox

ancestorId - the Id of the removed Mailbox ancestor

Compliance:

mandatory - This method must be implemented.

deletedDescendantMailbox

void deletedDescendantMailbox(Id mailboxId,
                            Id descendantId)

The callback for notifications of deleted mailbox descendants.

Parameters:

mailboxId - the Id of the Mailbox

descendantId - the Id of the removed Mailbox descendant

Compliance:

mandatory - This method must be implemented.

restructuredMailboxHierarchy

void restructuredMailboxHierarchy()

The callback for notifications of changes to a mailbox hierarchy where the hierarchy needs to refreshed.

Compliance:

mandatory - This method must be implemented.