org.osid.contact.batch

Interface ContactBatchAdminSession

All Superinterfaces:

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

public interface ContactBatchAdminSession
extends ContactAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasContacts(AliasRequestList aliasRequests) Adds an Id to a Contact for the purpose of creating compatibility.
CreateResponseList	createContacts(ContactBatchFormList contactForms) Creates a new set of Contacts.
DeleteResponseList	deleteAllContacts() Deletes all Contacts in this AddressBook .
DeleteResponseList	deleteContacts(IdList contactIds) Deletes contacts for the given Ids.
DeleteResponseList	deleteContactsForAddress(Id addressId) Deletes contacts for the given address.
DeleteResponseList	deleteContactsForWork(Id referenceId) Deletes contacts for the given reference.
DeleteResponseList	deleteIneffectiveContactsByDate(DateTime date) Deletes contacts expired before the given date.
ContactBatchFormList	getContactFormsForCreate(ContactPeerList peers, Type[] contactRecordTypes) Gets the contact forms for creating a bunch of new contacts.
ContactBatchFormList	getContactFormsForUpdate(IdList contactIds) Gets the contact forms for updating an existing set of contacts.
UpdateResponseList	updateContacts(ContactBatchFormList contactForms) Updates existing contacts.

Methods inherited from interface org.osid.contact.ContactAdminSession

aliasContact, canCreateContacts, canCreateContactWithRecordTypes, canDeleteContacts, canManageContactAliases, canUpdateContacts, createContact, deleteContact, getAddressBook, getAddressBookId, getContactFormForCreate, getContactFormForUpdate, updateContact

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

getContactFormsForCreate

ContactBatchFormList getContactFormsForCreate(ContactPeerList peers,
                                            Type[] contactRecordTypes)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

peers - the relationship peers

contactRecordTypes - array of contact record types to be included in each create operation or an empty list if none

Returns:

the contact forms

Throws:

NotFoundException - an addressId or referenceId is not found

NullArgumentException - peers or contactRecordTypes 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.

createContacts

CreateResponseList createContacts(ContactBatchFormList contactForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

contactForms - the contact forms

Returns:

the create responses

Throws:

NullArgumentException - contactForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getContactFormsForUpdate

ContactBatchFormList getContactFormsForUpdate(IdList contactIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

contactIds - the Ids of the Contact

Returns:

the contact form

Throws:

NotFoundException - a contactId is not found

NullArgumentException - contactIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateContacts

UpdateResponseList updateContacts(ContactBatchFormList contactForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 .

Parameters:

contactForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - contactForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllContacts

DeleteResponseList deleteAllContacts()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Contacts in this AddressBook .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteContacts

DeleteResponseList deleteContacts(IdList contactIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes contacts for the given Ids.

Parameters:

contactIds - the Ids of the contacts to delete

Returns:

the delete responses

Throws:

NullArgumentException - contactIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteContactsForAddress

DeleteResponseList deleteContactsForAddress(Id addressId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Deletes contacts for the given address.

Parameters:

addressId - the Id of an address

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteContactsForWork

DeleteResponseList deleteContactsForWork(Id referenceId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes contacts for the given reference.

Parameters:

referenceId - the Id of a reference

Returns:

the delete responses

Throws:

NullArgumentException - referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveContactsByDate

DeleteResponseList deleteIneffectiveContactsByDate(DateTime date)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes contacts expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasContacts

AliasResponseList aliasContacts(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

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.

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.