public interface AddressBookBatchAdminSession extends AddressBookAdminSession
This session creates, updates, and deletes AddressBooks
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 an
AddressBook,
an AddressBookForm
is requested
using getAddressBookFormsForCreate()
specifying the desired
record Types
or none if no record Types
are
needed. Each of the returned AddressBookForms
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 an AddressBookForm
is submiited to a create operation, it cannot be reused with
another create operation unless the first operation was unsuccessful. Each
AddressBookForm
corresponds to an attempted transaction.
The AddressBookForms
returned from
getAddressBookFormsForCreate()
may be linked to the originating
request through the peer Ids
of the AddressBookForm.
In the case where there may be duplicates, any
AddressBookForm
of the same peer Ids
may be used
for a create operation.
Once a batch of AddressBookForms
are submitted for
create, a CreateResponse
is returned for each
AddressBookForm,
although the ordering is not defined. Only errors
that pertain to the entire create operation are returned from
createAddressBooks(),
errors specific to an individual
AddressBookForm
are indicated in the corresponding
CreateResponse.
CreateResponses
may be linked to
the originating AddressBookForm
through the
AddressBookForm
Id
.
For updates, AddressBookForms
are requested to the
AddressBook
Id
that is to be updated using
getAddressBookFormsForUpdate()
where the reference
Id
in the AddressBookForm
may be used to link the
request. Similarly, the AddressBookForm
has metadata about
the data that can be updated and it can perform validation before
submitting the update. The AddressBookForm
can only be used
once for a successful update and cannot be reused.
Once a batch of AddressBookForms
are submitted for
update, an UpdateResponse
is returned for each
AddressBookForm,
although the ordering is not defined. Only errors
that pertain to the entire update operation are returned from
updateAddressBooks(),
errors specific to an individual
AddressBookForm
are indicated in the corresponding
UpdateResponse.
UpdateResponses
may be linked to
the originating AddressBookForm
through the
AddressBookForm
Id.
The delete operations delete AddressBooks
in bulk. Bulk
delete operations return the results in DeleteResponses.
Modifier and Type | Method and Description |
---|---|
AliasResponseList |
aliasAddressBooks(AliasRequestList aliasRequests)
Adds an
Id to an AddressBook for the
purpose of creating compatibility. |
CreateResponseList |
createAddressBooks(AddressBookBatchFormList addressBookForms)
Creates a new set of
Address Books. |
DeleteResponseList |
deleteAddressBooks(IdList addressBookIds)
Deletes address books for the given
Ids. |
DeleteResponseList |
deleteAllAddressBooks()
Deletes all
AddressBooks. |
AddressBookBatchFormList |
getAddressBookFormsForCreate(long number,
Type[] addressBookRecordTypes)
Gets the address book forms for creating a bunch of new address books.
|
AddressBookBatchFormList |
getAddressBookFormsForUpdate(IdList addressBookIds)
Gets the address book forms for updating an existing set of address
books.
|
UpdateResponseList |
updateAddressBooks(AddressBookBatchFormList addressBookForms)
Updates existing address books.
|
aliasAddressBook, canCreateAddressBooks, canCreateAddressBookWithRecordTypes, canDeleteAddressBooks, canManageAddressBookAliases, canUpdateAddressBooks, createAddressBook, deleteAddressBook, getAddressBookFormForCreate, getAddressBookFormForUpdate, updateAddressBook
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
AddressBookBatchFormList getAddressBookFormsForCreate(long number, Type[] addressBookRecordTypes) throws OperationFailedException, PermissionDeniedException
number
- the number of forms to retrieveaddressBookRecordTypes
- array of address book record types to
be included in each create operation or an empty list if noneNullArgumentException
- addressBookRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createAddressBooks(AddressBookBatchFormList addressBookForms) throws OperationFailedException, PermissionDeniedException
Address Books.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.addressBookForms
- the address book formsNullArgumentException
- addressBookForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AddressBookBatchFormList getAddressBookFormsForUpdate(IdList addressBookIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
addressBookIds
- the Ids
of the
AddressBook
NotFoundException
- an addressBookId
is
not foundNullArgumentException
- addressBookIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateAddressBooks(AddressBookBatchFormList addressBookForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.addressBookForms
- the form containing the elements to be
updatedNullArgumentException
- addressBookForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllAddressBooks() throws OperationFailedException, PermissionDeniedException
AddressBooks.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
Ids.
addressBookIds
- the Ids
of the address books to
deleteNullArgumentException
- addressBookIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasAddressBooks(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
Id
to an AddressBook
for the
purpose of creating compatibility. The primary Id
of
the AddressBook
is determined by the provider. The new
Id
is an alias to the primary Id.
If the
alias is a pointer to another address book, it is reassigned to the
given address book Id.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.