Interface PoolEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PoolEnablerSearchSession
public interface PoolEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchPoolEnablers

      boolean canSearchPoolEnablers()
      Tests if this user can perform PoolEnabler 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 enablers 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.

    • getPoolEnablerQuery

      PoolEnablerQuery getPoolEnablerQuery()
      Gets a pool enabler query.
      Returns:
      the pool enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getPoolEnablersByQuery

      PoolEnablerList getPoolEnablersByQuery(PoolEnablerQuery poolEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of PoolEnablers matching the given search.
      Parameters:
      poolEnablerQuery - the pool enabler query
      Returns:
      the returned PoolEnablerList
      Throws:
      NullArgumentException - poolEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - poolEnablerQuery did not originate from getPoolEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.