Interface PoolConstrainerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
PoolConstrainerSearchSession
public interface PoolConstrainerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchPoolConstrainers

      boolean canSearchPoolConstrainers()
      Tests if this user can perform PoolConstrainer 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 constrainers 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.

    • getPoolConstrainerQuery

      PoolConstrainerQuery getPoolConstrainerQuery()
      Gets a pool constrainer query.
      Returns:
      the pool constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getPoolConstrainersByQuery

      PoolConstrainerList getPoolConstrainersByQuery(PoolConstrainerQuery poolConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of PoolConstrainers matching the given search.
      Parameters:
      poolConstrainerQuery - the pool constrainer query
      Returns:
      the returned PoolConstrainerList
      Throws:
      NullArgumentException - poolConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - poolConstrainerQuery did not originate from getPoolConstrainerQuery()
      Compliance:
      mandatory - This method must be implemented.