OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.Mailbox
Implementsosid.OsidCatalog
Description

A mailbox defines a collection of messages.

MethodgetMailboxRecord
Description

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 .

Parametersosid.type.TypemailboxRecordTypethe mailbox record type
Returnosid.messaging.records.MailboxRecordthe mailbox record
ErrorsNULL_ARGUMENT mailboxRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(mailboxRecordType) is false
CompliancemandatoryThis method must be implemented.