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.
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.
|
aliasContact, canCreateContacts, canCreateContactWithRecordTypes, canDeleteContacts, canManageContactAliases, canUpdateContacts, createContact, deleteContact, getAddressBook, getAddressBookId, getContactFormForCreate, getContactFormForUpdate, updateContact
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ContactBatchFormList getContactFormsForCreate(ContactPeerList peers, Type[] contactRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
peers
- the relationship peerscontactRecordTypes
- array of contact record types to be
included in each create operation or an empty list if noneNotFoundException
- an addressId
or
referenceId
is not foundNullArgumentException
- peers
or
contactRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createContacts(ContactBatchFormList contactForms) throws OperationFailedException, PermissionDeniedException
Contacts.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateResponse
.contactForms
- the contact formsNullArgumentException
- contactForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ContactBatchFormList getContactFormsForUpdate(IdList contactIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
contactIds
- the Ids
of the Contact
NotFoundException
- a contactId
is not
foundNullArgumentException
- contactIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateContacts(ContactBatchFormList contactForms) throws OperationFailedException, PermissionDeniedException
BatchCreateResponse
.contactForms
- the form containing the elements to be updatedNullArgumentException
- contactForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllContacts() throws OperationFailedException, PermissionDeniedException
Contacts
in this AddressBook
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteContacts(IdList contactIds) throws OperationFailedException, PermissionDeniedException
Ids.
contactIds
- the Ids
of the contacts to deleteNullArgumentException
- contactIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteContactsForAddress(Id addressId) throws OperationFailedException, PermissionDeniedException
addressId
- the Id
of an addressNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteContactsForWork(Id referenceId) throws OperationFailedException, PermissionDeniedException
referenceId
- the Id
of a referenceNullArgumentException
- referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteIneffectiveContactsByDate(DateTime date) throws OperationFailedException, PermissionDeniedException
date
- a dateNullArgumentException
- date
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasContacts(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.