org.osid.messaging

Interface Mailbox

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Mailbox
extends OsidCatalog

A mailbox defines a collection of messages.

Method Summary

Methods

Modifier and Type	Method and Description
MailboxRecord	getMailboxRecord(Type mailboxRecordType) Gets the record corresponding to the given Mailbox record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getMailboxRecord

MailboxRecord getMailboxRecord(Type mailboxRecordType)
                               throws OperationFailedException

Gets the record corresponding to the given Mailbox record Type. This method is used to retrieve an object implementing the requested record. The mailboxRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(mailboxRecordType) is true .

Parameters:

mailboxRecordType - the mailbox record type

Returns:

the mailbox record

Throws:

NullArgumentException - mailboxRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mailboxRecordType) is false

Compliance:

mandatory - This method must be implemented.