OSID Logo
OSID Specifications
contact batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.batch.ContactBatchAdminSession
Implementsosid.contact.ContactAdminSession
Description

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

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

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

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

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

The delete operations delete Contacts in bulk. To unmap a Contact from the current AddressBook, the ContactAddressBookAssignmentSession should be used. These delete operations attempt to remove the Contact itself thus removing it from all known AddressBook catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetContactFormsForCreate
Description

Gets the contact forms for creating a bunch of new contacts.

Parametersosid.contact.batch.ContactPeerListpeersthe relationship peers
osid.type.Type[]contactRecordTypesarray of contact record types to be included in each create operation or an empty list if none
Returnosid.contact.batch.ContactBatchFormListthe contact forms
ErrorsNOT_FOUNDan addressId or referenceId is not found
NULL_ARGUMENT peers or contactRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateContacts
Description

Creates a new set of Contacts. 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.ContactBatchFormListcontactFormsthe contact forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT contactForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetContactFormsForUpdate
Description

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

Parametersosid.id.IdListcontactIdsthe Ids of the Contact
Returnosid.contact.batch.ContactBatchFormListthe contact form
ErrorsNOT_FOUNDa contactId is not found
NULL_ARGUMENT contactIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateContacts
Description

Updates existing contacts. 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.ContactBatchFormListcontactFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT contactForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllContacts
Description

Deletes all Contacts in this AddressBook .

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

Deletes contacts for the given Ids.

Parametersosid.id.IdListcontactIdsthe Ids of the contacts to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT contactIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteContactsForAddress
Description

Deletes contacts for the given address.

Parametersosid.id.IdaddressIdthe Id of an address
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteContactsForWork
Description

Deletes contacts for the given reference.

Parametersosid.id.IdreferenceIdthe Id of a reference
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveContactsByDate
Description

Deletes contacts expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasContacts
Description

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