OSID Logo
OSID Specifications
contact batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.batch.AddressBatchAdminSession
Implementsosid.contact.AddressAdminSession
Description

This session creates, updates, and deletes Addresses 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 Address, an AddressForm is requested using getAddressFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned AddressForms 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 AddressForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AddressForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Addresses in bulk. To unmap an Address from the current AddressBook, the AddressAddressBookAssignmentSession should be used. These delete operations attempt to remove the Address itself thus removing it from all known AddressBook catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetAddressFormsForCreate
Description

Gets the address forms for creating a bunch of new addresses.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]addressRecordTypesarray of address record types to be included in each create operation or an empty list if none
Returnosid.contact.batch.AddressBatchFormListthe address forms
ErrorsNULL_ARGUMENT addressRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateAddresses
Description

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

Parametersosid.contact.batch.AddressBatchFormListaddressFormsthe address forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT addressForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAddressFormsForUpdate
Description

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

Parametersosid.id.IdListaddressIdsthe Ids of the Address
Returnosid.contact.batch.AddressBatchFormListthe address form
ErrorsNOT_FOUNDan addressId is not found
NULL_ARGUMENT addressIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAddresses
Description

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

Parametersosid.contact.batch.AddressBatchFormListaddressFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT addressForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllAddresses
Description

Deletes all Addresses in this AddressBook .

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

Deletes addresses for the given Ids.

Parametersosid.id.IdListaddressIdsthe Ids of the addresses to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT addressIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasAddresses
Description

Adds an Id to an Address for the purpose of creating compatibility. The primary Id of the Address is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another address, it is reassigned to the given address 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.