Interface PoolQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PoolSearchSession
public interface PoolQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated broker view: searches include pools in brokers of which this broker is an ancestor in the broker hierarchy
  • isolated broker view: searches are restricted to pools in this broker

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

  • Method Details

    • getDistributorId

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

    • getDistributor

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

    • canSearchPools

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

    • useFederatedDistributorView

      void useFederatedDistributorView()
      Federates the view for methods in this session. A federated view will include pools in distributors which are children of this broker in the distributor hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDistributorView

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

    • getPoolQuery

      PoolQuery getPoolQuery()
      Gets a pool query.
      Returns:
      the pool query
      Compliance:
      mandatory - This method must be implemented.

    • getPoolsByQuery

      PoolList getPoolsByQuery(PoolQuery poolQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Pools matching the given pool query.
      Parameters:
      poolQuery - the pool query
      Returns:
      the returned PoolList
      Throws:
      NullArgumentException - poolQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - poolQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.