Interface | osid.messaging.batch.MailboxBatchAdminSession | ||
---|---|---|---|
Implements | osid.messaging.MailboxAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getMailboxFormsForCreate | ||
Description |
Gets the mailbox forms for creating a bunch of new mailboxes. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | mailboxRecordTypes | array of mailbox record types to be included in each create operation or an empty list if none | |
Return | osid.messaging.batch.MailboxBatchFormList | the mailbox forms | |
Errors | NULL_ARGUMENT | mailboxRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createMailboxes | ||
Description |
Creates a new set of | ||
Parameters | osid.messaging.batch.MailboxBatchFormList | mailboxForms | the mailbox forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | mailboxForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMailboxFormsForUpdate | ||
Description |
Gets the mailbox forms for updating an existing set of mailboxes. A new mailbox form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | mailboxIds | the Ids of the Mailbox |
Return | osid.messaging.batch.MailboxBatchFormList | the mailbox form | |
Errors | NOT_FOUND | a mailboxId is not found | |
NULL_ARGUMENT | mailboxIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateMailboxes | ||
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
| ||
Parameters | osid.messaging.batch.MailboxBatchFormList | mailboxForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | mailboxForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllMailboxes | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteMailboxes | ||
Description |
Deletes mailboxes for the given | ||
Parameters | osid.id.IdList | mailboxIds | the Ids of the mailboxes to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | mailboxIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasMailboxes | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |