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

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

MethodgetMailboxId
Description

Gets the Mailbox Id of the mailbox to be updated if this is an update transaction.

Returnosid.id.Idthe mailbox Id
ErrorsILLEGAL_STATE isForUpdate() is false
CompliancemandatoryThis method must be implemented.
MethodgetParentsMetadata
Description

Gets the metadata for setting the hierarchical parents of this mailbox.

Returnosid.Metadatametadata for the parents
CompliancemandatoryThis method must be implemented.
MethodsetParents
Description

Sets the hierarchical parents.

Parametersosid.id.Id[]parentsthe new parents
ErrorsINVALID_ARGUMENT parents is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT parents is null
CompliancemandatoryThis method must be implemented.
MethodclearParents
Description

Removes the hierarchical parents.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.