org.osid.contact.batch

Interface ContactBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, ContactBatchProfile, OsidManager, OsidProfile, Sourceable

public interface ContactBatchManager
extends OsidManager, ContactBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AddressBatchAdminSession	getAddressBatchAdminSession() Gets the OsidSession associated with the bulk address administration service.
AddressBatchAdminSession	getAddressBatchAdminSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the bulk address administration service for the given address book.
AddressBookBatchAdminSession	getAddressBookBatchAdminSession() Gets the OsidSession associated with the bulk address book administration service.
ContactBatchAdminSession	getContactBatchAdminSession() Gets the OsidSession associated with the bulk contact administration service.
ContactBatchAdminSession	getContactBatchAdminSessionForAddressBook(Id addressBookId) Gets the OsidSession associated with the bulk contact administration service for the given address book.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.contact.batch.ContactBatchProfile

supportsAddressBatchAdmin, supportsAddressBookBatchAdmin, supportsContactBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getContactBatchAdminSession

ContactBatchAdminSession getContactBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk contact administration service.

Returns:

a ContactBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsContactBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsContactBatchAdmin() is true.

getContactBatchAdminSessionForAddressBook

ContactBatchAdminSession getContactBatchAdminSessionForAddressBook(Id addressBookId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

a ContactBatchAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsContactBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsContactBatchAdmin() and supportsVisibleFederation() are true

getAddressBatchAdminSession

AddressBatchAdminSession getAddressBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk address administration service.

Returns:

an AddressBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAddressBatchAdmin() is true.

getAddressBatchAdminSessionForAddressBook

AddressBatchAdminSession getAddressBatchAdminSessionForAddressBook(Id addressBookId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

addressBookId - the Id of the AddressBook

Returns:

an AddressBatchAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAddressBatchAdmin() and supportsVisibleFederation() are true

getAddressBookBatchAdminSession

AddressBookBatchAdminSession getAddressBookBatchAdminSession()
                                                             throws OperationFailedException

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

Returns:

a AddressBookBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAddressBookBatchAdmin() is true.