public interface MailboxBatchAdminSession extends MailboxAdminSession
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.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasMailboxes(AliasRequestList aliasRequests)
Adds an
Id to a Mailbox for the purpose
of creating compatibility. |
CreateResponseList |
createMailboxes(MailboxBatchFormList mailboxForms)
Creates a new set of
Mailboxes. |
DeleteResponseList |
deleteAllMailboxes()
Deletes all
Mailboxes. |
DeleteResponseList |
deleteMailboxes(IdList mailboxIds)
Deletes mailboxes for the given
Ids. |
MailboxBatchFormList |
getMailboxFormsForCreate(long number,
Type[] mailboxRecordTypes)
Gets the mailbox forms for creating a bunch of new mailboxes.
|
MailboxBatchFormList |
getMailboxFormsForUpdate(IdList mailboxIds)
Gets the mailbox forms for updating an existing set of mailboxes.
|
UpdateResponseList |
updateMailboxes(MailboxBatchFormList mailboxForms)
Updates existing mailboxes.
|
aliasMailbox, canCreateMailboxes, canCreateMailboxWithRecordTypes, canDeleteMailboxes, canManageMailboxAliases, canUpdateMailboxes, createMailbox, deleteMailbox, getMailboxFormForCreate, getMailboxFormForUpdate, updateMailbox
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
MailboxBatchFormList getMailboxFormsForCreate(long number, Type[] mailboxRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrievemailboxRecordTypes
- array of mailbox record types to be
included in each create operation or an empty list if noneNullArgumentException
- mailboxRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createMailboxes(MailboxBatchFormList mailboxForms) throws OperationFailedException, PermissionDeniedException
Mailboxes.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.mailboxForms
- the mailbox formsNullArgumentException
- mailboxForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. MailboxBatchFormList getMailboxFormsForUpdate(IdList mailboxIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
mailboxIds
- the Ids
of the Mailbox
NotFoundException
- a mailboxId
is not
foundNullArgumentException
- mailboxIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateMailboxes(MailboxBatchFormList mailboxForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.mailboxForms
- the form containing the elements to be updatedNullArgumentException
- mailboxForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllMailboxes() throws OperationFailedException, PermissionDeniedException
Mailboxes.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteMailboxes(IdList mailboxIds) throws OperationFailedException, PermissionDeniedException
Ids.
mailboxIds
- the Ids
of the mailboxes to deleteNullArgumentException
- mailboxIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasMailboxes(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.