Interface ContactEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ContactEnablerSearchSession
public interface ContactEnablerQuerySession extends OsidSession

This session provides methods for searching among ContactEnabler objects. The search query is constructed using the ContactEnablerQuery.

This session defines views that offer differing behaviors for searching.

  • federated address book view: searches include contact enablers in address books of which this address book is an ancestor in the address book hierarchy
  • isolated address book view: searches are restricted to contact enablers in this address book

Contact enablers may have a query record indicated by their respective record types. The query record is accessed via the ContactEnablerQuery.

Like all OsidSessions, ContactEnablerQuerySessions are dedicated to single processing threads and a single authenticated user.

  • 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.

    • canSearchContactEnablers

      boolean canSearchContactEnablers()
      Tests if this user can perform ContactEnabler lookups. 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 offer lookup 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 contact enablers in address books which are children of this broker in the address book hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedAddressBookView

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

    • getContactEnablerQuery

      ContactEnablerQuery getContactEnablerQuery()
      Gets a contact enabler query.
      Returns:
      the contact enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getContactEnablersByQuery

      ContactEnablerList getContactEnablersByQuery(ContactEnablerQuery contactEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of ContactEnablers matching the given contact enabler query.
      Parameters:
      contactEnablerQuery - the contact enabler query
      Returns:
      the returned ContactEnablerList
      Throws:
      NullArgumentException - contactEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - contactEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.