Interface ContactBatchManager

All Superinterfaces:
AutoCloseable, Closeable, ContactBatchProfile, OsidManager, 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 Details

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