OSID Logo
OSID Specifications
contact batch package
Version 3.0.0
Interfaceosid.contact.batch.ContactBatchProxyManager
Implementsosid.OsidProxyManager
osid.contact.batch.ContactBatchProfile
Used Byosid.contact.ContactProxyManager
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 Proxy object. The sessions included in this manager are:

  • ContactBatchSession : a session to create, modify and delete contacts in bulk
  • AddressBatchAdminSession : a session to create, modify and delete addresses in bulk
  • AddressBookBatchAdminSession : a session to create, modify and delete address books in bulk
MethodgetContactBatchAdminSession
Description

Gets the OsidSession associated with the bulk contact administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.batch.ContactBatchAdminSessiona ContactBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsContactBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsContactBatchAdmin() is true .
MethodgetContactBatchAdminSessionForAddressBook
Description

Gets the OsidSession associated with the bulk contact administration service for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.batch.ContactBatchAdminSessiona ContactBatchAdminSession
ErrorsNOT_FOUNDno AddressBook found by the given Id
NULL_ARGUMENTaddressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsContactBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsContactBatchAdmin() and supportsVisibleFederation() are true
MethodgetAddressBatchAdminSession
Description

Gets the OsidSession associated with the bulk address administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.batch.AddressBatchAdminSessionan AddressBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAddressBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAddressBatchAdmin() is true .
MethodgetAddressBatchAdminSessionForAddressBook
Description

Gets the OsidSession associated with the bulk address administration service for the given address book.

Parametersosid.id.IdaddressBookIdthe Id of the AddressBook
osid.proxy.Proxyproxya proxy
Returnosid.contact.batch.AddressBatchAdminSessionan AddressBatchAdminSession
ErrorsNOT_FOUNDno AddressBook found by the given Id
NULL_ARGUMENTaddressBookId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAddressBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAddressBatchAdmin() and supportsVisibleFederation() are true
MethodgetAddressBookBatchAdminSession
Description

Gets the OsidSession associated with the bulk address book administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.contact.batch.AddressBookBatchAdminSessiona AddressBookBatchAdminSession
ErrorsNULL_ARGUMENTproxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAddressBookBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookBatchAdmin() is true .