Interface AddressQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AddressSearchSession
public interface AddressQuerySession extends OsidSession

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

Addresses may have a query record indicated by their respective record types. The query record is accessed via the AddressQuery. 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.

    • canSearchAddresses

      boolean canSearchAddresses()
      Tests if this user can perform Address 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 opt not 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 addresses 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.

    • getAddressQuery

      AddressQuery getAddressQuery()
      Gets an address query.
      Returns:
      the address query
      Compliance:
      mandatory - This method must be implemented.

    • getAddressesByQuery

      AddressList getAddressesByQuery(AddressQuery addressQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Addresses matching the given search.
      Parameters:
      addressQuery - the address query
      Returns:
      the returned AddressList
      Throws:
      NullArgumentException - addressQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - addressQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.