OSID Logo
OSID Specifications
contact batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.batch.ContactBatchManager
Implementsosid.OsidManager
osid.contact.batch.ContactBatchProfile
Description

The contact batch manager provides access to contact batch sessions and provides interoperability tests for various aspects of this service. 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.

Returnosid.contact.batch.ContactBatchAdminSessiona ContactBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactBatchAdmin() 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
Returnosid.contact.batch.ContactBatchAdminSessiona ContactBatchAdminSession
ErrorsNOT_FOUNDno AddressBook found by the given Id
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsContactBatchAdmin() 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.

Returnosid.contact.batch.AddressBatchAdminSessionan AddressBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBatchAdmin() 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
Returnosid.contact.batch.AddressBatchAdminSessionan AddressBatchAdminSession
ErrorsNOT_FOUNDno AddressBook found by the given Id
NULL_ARGUMENT addressBookId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBatchAdmin() 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.

Returnosid.contact.batch.AddressBookBatchAdminSessiona AddressBookBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAddressBookBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAddressBookBatchAdmin() is true.