org.osid.contact.batch

Interface AddressBookBatchAdminSession

All Superinterfaces:

AddressBookAdminSession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.contact.AddressBookAdminSession

aliasAddressBook, canCreateAddressBooks, canCreateAddressBookWithRecordTypes, canDeleteAddressBooks, canManageAddressBookAliases, canUpdateAddressBooks, createAddressBook, deleteAddressBook, getAddressBookFormForCreate, getAddressBookFormForUpdate, updateAddressBook

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getAddressBookFormsForCreate

AddressBookBatchFormList getAddressBookFormsForCreate(long number,
                                                    Type[] addressBookRecordTypes)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets the address book forms for creating a bunch of new address books.

Parameters:

number - the number of forms to retrieve

addressBookRecordTypes - array of address book record types to be included in each create operation or an empty list if none

Returns:

the address book forms

Throws:

NullArgumentException - addressBookRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createAddressBooks

CreateResponseList createAddressBooks(AddressBookBatchFormList addressBookForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Creates a new set of 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 .

Parameters:

addressBookForms - the address book forms

Returns:

the create responses

Throws:

NullArgumentException - addressBookForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAddressBookFormsForUpdate

AddressBookBatchFormList getAddressBookFormsForUpdate(IdList addressBookIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the address book forms for updating an existing set of address books. A new address book form should be requested for each update transaction.

Parameters:

addressBookIds - the Ids of the AddressBook

Returns:

the address book form

Throws:

NotFoundException - an addressBookId is not found

NullArgumentException - addressBookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAddressBooks

UpdateResponseList updateAddressBooks(AddressBookBatchFormList addressBookForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

addressBookForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - addressBookForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllAddressBooks

DeleteResponseList deleteAllAddressBooks()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all AddressBooks.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAddressBooks

DeleteResponseList deleteAddressBooks(IdList addressBookIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes address books for the given Ids.

Parameters:

addressBookIds - the Ids of the address books to delete

Returns:

the delete responses

Throws:

NullArgumentException - addressBookIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasAddressBooks

AliasResponseList aliasAddressBooks(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Adds an 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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.