Interface ContactQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ContactSearchSession
public interface ContactQuerySession extends OsidSession

This session provides methods for searching Contacts . The search query is constructed using the ContactQuery . The address record Type also specifies the record for the address query.

Contacts may have a query record indicated by their respective record types. The query record is accessed via the ContactQuery . The returns in this session may not be cast directly to these interfaces.

  • Method Details

    • getAddressBookId

      Id getAddressBookId()
      Gets the AddressBook Id associated with this session.
      Returns:
      the AddressBook Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getAddressBook

      AddressBook getAddressBook() throws OperationFailedException, PermissionDeniedException
      Gets the AddressBook associated with this session.
      Returns:
      the address book
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchContacts

      boolean canSearchContacts()
      Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedAddressBookView

      void useFederatedAddressBookView()
      Federates the view for methods in this session. A federated view will include contacts in address books which are children of this address book in the address book hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAddressBookView

      void useIsolatedAddressBookView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this address book only.
      Compliance:
      mandatory - This method is must be implemented.

    • getContactQuery

      ContactQuery getContactQuery()
      Gets a contact query.
      Returns:
      the contact query
      Compliance:
      mandatory - This method must be implemented.

    • getContactsByQuery

      ContactList getContactsByQuery(ContactQuery contactQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of contacts matching the given contact query.
      Parameters:
      contactQuery - the contact query
      Returns:
      the returned ContactList
      Throws:
      NullArgumentException - contactQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - contactQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.