Interface AccountQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AccountSearchSession
public interface AccountQuerySession extends OsidSession

This session provides methods for searching among Accounts. The search query is constructed using the AccountQuery.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include accounts in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to accounts in this business

Accounts may have a query record indicated by their respective record types. The query record is accessed via the AccountQuery.

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

  • Method Details

    • getBusinessId

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

    • getBusiness

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

    • canSearchAccounts

      boolean canSearchAccounts()
      Tests if this user can perform Account 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.

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include accounts in business which are children of this business in the business hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedBusinessView

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

    • getAccountQuery

      AccountQuery getAccountQuery()
      Gets an account query.
      Returns:
      the account query
      Compliance:
      mandatory - This method must be implemented.

    • getAccountsByQuery

      AccountList getAccountsByQuery(AccountQuery accountsQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Accounts matching the given account query.
      Parameters:
      accountsQuery - the account query
      Returns:
      the returned AccountList
      Throws:
      NullArgumentException - accountQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - accountQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.