org.osid.contact.batch

Interface ContactBatchProxyManager

All Superinterfaces:

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

public interface ContactBatchProxyManager
extends OsidProxyManager, ContactBatchProfile

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

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk contact administration service.

Parameters:

proxy - a proxy

Returns:

a ContactBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                 Proxy proxy)
                                                                   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

proxy - a proxy

Returns:

a ContactBatchAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk address administration service.

Parameters:

proxy - a proxy

Returns:

an AddressBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                 Proxy proxy)
                                                                   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

proxy - a proxy

Returns:

an AddressBatchAdminSession

Throws:

NotFoundException - no AddressBook found by the given Id

NullArgumentException - addressBookId or proxy 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(Proxy proxy)
                                                             throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a AddressBookBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAddressBookBatchAdmin() is false

Compliance:

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