Interface ContactBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, ContactBatchProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface ContactBatchProfile

supportsAddressBatchAdmin, supportsAddressBookBatchAdmin, supportsContactBatchAdmin, supportsVisibleFederation

Modifier and Type	Method	Description
boolean	supportsAddressBatchAdmin()	Tests if bulk administration of addresses is available.
boolean	supportsAddressBookBatchAdmin()	Tests if bulk administration of address books is available.
boolean	supportsContactBatchAdmin()	Tests if bulk administration of contacts is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsContactBatchAdmin()} is {@code 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 {@code supportsContactBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressBatchAdmin()} is {@code 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 {@code supportsAddressBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAddressBookBatchAdmin()} is {@code true} .