| Interface | osid.contact.batch.ContactBatchProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.contact.batch.ContactBatchProfile | |||
| Description | 
                 The contact batch proxy manager provides access to contact 
                batch sessions and provides interoperability tests for various 
                aspects of this service. Methods in this manager support the 
                passing of a  
  | ||
| Method | getContactBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.contact.batch.ContactBatchAdminSession | a  ContactBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsContactBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsContactBatchAdmin() 
 is  true.   | |
| Method | getContactBatchAdminSessionForAddressBook | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | addressBookId | the  Id  of the  AddressBook   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.contact.batch.ContactBatchAdminSession | a  ContactBatchAdminSession   | |
| Errors | NOT_FOUND | no  AddressBook  found by the given  Id   |                 |
| NULL_ARGUMENT |  addressBookId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsContactBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsContactBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getAddressBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.contact.batch.AddressBatchAdminSession | an  AddressBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsAddressBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAddressBatchAdmin() 
 is  true.   | |
| Method | getAddressBatchAdminSessionForAddressBook | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.id.Id | addressBookId | the  Id  of the  AddressBook   | 
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.contact.batch.AddressBatchAdminSession | an  AddressBatchAdminSession   | |
| Errors | NOT_FOUND | no  AddressBook  found by the given  Id   |                 |
| NULL_ARGUMENT |  addressBookId  or  proxy  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsAddressBatchAdmin()  or  
supportsVisibleFederation()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAddressBatchAdmin() 
 and  supportsVisibleFederation()  are  true   | |
| Method | getAddressBookBatchAdminSession | ||
| Description | 
                     Gets the   | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy | 
| Return | osid.contact.batch.AddressBookBatchAdminSession | a  AddressBookBatchAdminSession   | |
| Errors | NULL_ARGUMENT |  proxy  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED |  supportsAddressBookBatchAdmin()  is  false   |                 ||
| Compliance | optional | This method must be implemented if  supportsAddressBookBatchAdmin() 
 is  true.   | |