OSID Logo
OSID Specifications
messaging package
Version 3.1.0
Interfaceosid.messaging.MailboxForm
Implementsosid.OsidCatalogForm
Implemented Byosid.messaging.batch.MailboxBatchForm
Used Byosid.messaging.MailboxAdminSession
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.TypemailboxRecordType the mailbox record type
Returnosid.messaging.records.MailboxFormRecord the mailbox form record
ErrorsNULL_ARGUMENT mailboxRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(mailboxRecordType) is false
Compliancemandatory This method must be implemented.