org.osid.messaging

Interface MailboxForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidCatalogForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

MailboxBatchForm

public interface MailboxForm
extends OsidCatalogForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
MailboxFormRecord	getMailboxFormRecord(Type mailboxRecordType) Gets the MailboxFormRecord corresponding to the given mailbox record Type.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getMailboxFormRecord

MailboxFormRecord getMailboxFormRecord(Type mailboxRecordType)
                                       throws OperationFailedException

Gets the MailboxFormRecord corresponding to the given mailbox record Type.

Parameters:

mailboxRecordType - the mailbox record type

Returns:

the mailbox form record

Throws:

NullArgumentException - mailboxRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mailboxRecordType) is false

Compliance:

mandatory - This method must be implemented.