Interface ContactEnablerAddressBookSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ContactEnablerAddressBookSession extends OsidSession

This session provides methods to retrieve ContactEnabler to AddressBook mappings. A ContactEnabler may appear in multiple AddressBook objects. Each address book may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupContactEnablerAddressBookMappings

      boolean canLookupContactEnablerAddressBookMappings()
      Tests if this user can perform lookups of contact enabler/address book mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeContactEnablerAddressBookView

      void useComparativeContactEnablerAddressBookView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryContactEnablerAddressBookView

      void usePlenaryContactEnablerAddressBookView()
      A complete view of the ContactEnabler and AddressBook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getContactEnablerIdsByAddressBook

      IdList getContactEnablerIdsByAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of ContactEnablerIds associated with an AddressBook .
      Parameters:
      addressBookId - Id of the AddressBook
      Returns:
      list of related contact enabler Ids
      Throws:
      NotFoundException - addressBookId is not found
      NullArgumentException - addressBookId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersByAddressBook

      ContactEnablerList getContactEnablersByAddressBook(Id addressBookId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of contact enablers associated with an AddressBook .
      Parameters:
      addressBookId - Id of the AddressBook
      Returns:
      list of related contact enablers
      Throws:
      NotFoundException - addressBookId is not found
      NullArgumentException - addressBookId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablerIdsByAddressBooks

      IdList getContactEnablerIdsByAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of ContactEnablerIds corresponding to a list of AddressBooks .
      Parameters:
      addressBookIds - list of address book Ids
      Returns:
      list of contact enabler Ids
      Throws:
      NullArgumentException - addressBookIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersByAddressBooks

      ContactEnablerList getContactEnablersByAddressBooks(IdList addressBookIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of contact enablers corresponding to a list of AddressBooks .
      Parameters:
      addressBookIds - list of address book Ids
      Returns:
      list of contact enablers
      Throws:
      NullArgumentException - addressBookIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBookIdsByContactEnabler

      IdList getAddressBookIdsByContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AddressBook Ids mapped to a ContactEnabler .
      Parameters:
      contactEnablerId - Id of a ContactEnabler
      Returns:
      list of address books
      Throws:
      NotFoundException - contactEnablerId is not found
      NullArgumentException - contactEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBooksByContactEnabler

      AddressBookList getAddressBooksByContactEnabler(Id contactEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the AddressBooks mapped to a ContactEnabler .
      Parameters:
      contactEnablerId - Id of a ContactEnabler
      Returns:
      list of address books
      Throws:
      NotFoundException - contactEnablerId is not found
      NullArgumentException - contactEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.