Interface | osid.contact.batch.ContactBatchAdminSession | ||
---|---|---|---|
Implements | osid.contact.ContactAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getContactFormsForCreate | ||
Description |
Gets the contact forms for creating a bunch of new contacts. | ||
Parameters | osid.contact.batch.ContactPeerList | peers | the relationship peers |
osid.type.Type[] | contactRecordTypes | array of contact record types to be included in each create operation or an empty list if none | |
Return | osid.contact.batch.ContactBatchFormList | the contact forms | |
Errors | NOT_FOUND | an addressId or referenceId is not found | |
NULL_ARGUMENT | peers or contactRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createContacts | ||
Description |
Creates a new set of | ||
Parameters | osid.contact.batch.ContactBatchFormList | contactForms | the contact forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | contactForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getContactFormsForUpdate | ||
Description |
Gets the contact forms for updating an existing set of contacts. A new contact form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | contactIds | the Ids of the Contact |
Return | osid.contact.batch.ContactBatchFormList | the contact form | |
Errors | NOT_FOUND | a contactId is not found | |
NULL_ARGUMENT | contactIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateContacts | ||
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 | ||
Parameters | osid.contact.batch.ContactBatchFormList | contactForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | contactForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllContacts | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteContacts | ||
Description |
Deletes contacts for the given | ||
Parameters | osid.id.IdList | contactIds | the Ids of the contacts to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | contactIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteContactsForAddress | ||
Description |
Deletes contacts for the given address. | ||
Parameters | osid.id.Id | addressId | the Id of an address |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteContactsForWork | ||
Description |
Deletes contacts for the given reference. | ||
Parameters | osid.id.Id | referenceId | the Id of a reference |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | referenceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveContactsByDate | ||
Description |
Deletes contacts expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasContacts | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |