Interface | osid.contact.batch.AddressBatchAdminSession | ||
---|---|---|---|
Implements | osid.contact.AddressAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getAddressFormsForCreate | ||
Description |
Gets the address forms for creating a bunch of new addresses. | ||
Parameters | cardinal | number | the number of forms to retrieve |
osid.type.Type[] | addressRecordTypes | array of address record types to be included in each create operation or an empty list if none | |
Return | osid.contact.batch.AddressBatchFormList | the address forms | |
Errors | NULL_ARGUMENT | addressRecordTypes 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 | createAddresses | ||
Description |
Creates a new set of | ||
Parameters | osid.contact.batch.AddressBatchFormList | addressForms | the address forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | addressForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAddressFormsForUpdate | ||
Description |
Gets the address forms for updating an existing set of addresses. A new address form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | addressIds | the Ids of the Address |
Return | osid.contact.batch.AddressBatchFormList | the address form | |
Errors | NOT_FOUND | an addressId is not found | |
NULL_ARGUMENT | addressIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAddresses | ||
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
| ||
Parameters | osid.contact.batch.AddressBatchFormList | addressForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | addressForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAddresses | ||
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 | deleteAddresses | ||
Description |
Deletes addresses for the given | ||
Parameters | osid.id.IdList | addressIds | the Ids of the addresses to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | addressIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasAddresses | ||
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. |