OSID Logo
OSID Specifications
messaging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.messaging.batch.MailboxBatchAdminSession
Implementsosid.messaging.MailboxAdminSession
Description

This session creates, updates, and deletes Mailboxes in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Mailbox, a MailboxForm is requested using getMailboxFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned MailboxForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a MailboxForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each MailboxForm corresponds to an attempted transaction.

The MailboxForms returned from getMailboxFormsForCreate() may be linked to the originating request through the peer Ids of the MailboxForm. In the case where there may be duplicates, any MailboxForm of the same peer Ids may be used for a create operation.

Once a batch of MailboxForms are submitted for create, a CreateResponse is returned for each MailboxForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createMailboxes(), errors specific to an individual MailboxForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating MailboxForm through the MailboxForm Id .

For updates, MailboxForms are requested to the Mailbox Id that is to be updated using getMailboxFormsForUpdate() where the reference Id in the MailboxForm may be used to link the request. Similarly, the MailboxForm has metadata about the data that can be updated and it can perform validation before submitting the update. The MailboxForm can only be used once for a successful update and cannot be reused.

Once a batch of MailboxForms are submitted for update, an UpdateResponse is returned for each MailboxForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateMailboxes(), errors specific to an individual MailboxForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating MailboxForm through the MailboxForm Id.

The delete operations delete Mailboxes in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetMailboxFormsForCreate
Description

Gets the mailbox forms for creating a bunch of new mailboxes.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]mailboxRecordTypesarray of mailbox record types to be included in each create operation or an empty list if none
Returnosid.messaging.batch.MailboxBatchFormListthe mailbox forms
ErrorsNULL_ARGUMENT mailboxRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateMailboxes
Description

Creates a new set of Mailboxes. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.messaging.batch.MailboxBatchFormListmailboxFormsthe mailbox forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT mailboxForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMailboxFormsForUpdate
Description

Gets the mailbox forms for updating an existing set of mailboxes. A new mailbox form should be requested for each update transaction.

Parametersosid.id.IdListmailboxIdsthe Ids of the Mailbox
Returnosid.messaging.batch.MailboxBatchFormListthe mailbox form
ErrorsNOT_FOUNDa mailboxId is not found
NULL_ARGUMENT mailboxIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateMailboxes
Description

Updates existing mailboxes. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.messaging.batch.MailboxBatchFormListmailboxFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT mailboxForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllMailboxes
Description

Deletes all Mailboxes.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteMailboxes
Description

Deletes mailboxes for the given Ids.

Parametersosid.id.IdListmailboxIdsthe Ids of the mailboxes to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT mailboxIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasMailboxes
Description

Adds an Id to a Mailbox for the purpose of creating compatibility. The primary Id of the Mailbox is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another mailbox, it is reassigned to the given mailbox Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.