OSID Logo
OSID Specifications
messaging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.MailboxForm
Implementsosid.OsidCatalogForm
Description

This is the form for creating and updating mailboxes. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the MailboxAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetMailboxFormRecord
Description

Gets the MailboxFormRecord corresponding to the given mailbox record Type.

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