Interface PoolProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PoolProcessorSearchSession
public interface PoolProcessorQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated distributor view: searches include pool processors in distributors of which this distributor is an ancestor in the distributor hierarchy
  • isolated distributor view: searches are restricted to pool processors in this distributor

Pool processors may have a query record indicated by their respective record types. The query record is accessed via the PoolProcessorQuery .

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

    • canSearchPoolProcessors

      boolean canSearchPoolProcessors()
      Tests if this user can perform PoolProcessor 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 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 pool processors in distributors which are children of this distributor 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 searches to this distributor only.
      Compliance:
      mandatory - This method is must be implemented.

    • getPoolProcessorQuery

      PoolProcessorQuery getPoolProcessorQuery()
      Gets a pool processor query.
      Returns:
      the pool processor query
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorsByQuery

      PoolProcessorList getPoolProcessorsByQuery(PoolProcessorQuery poolProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of PoolProcessors matching the given search.
      Parameters:
      poolProcessorQuery - the pool processor query
      Returns:
      a pool processor list
      Throws:
      NullArgumentException - poolProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - poolProcessorQuery did not originate from getPoolProcessorQuery()
      Compliance:
      mandatory - This method must be implemented.