Interface RequestQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
RequestSearchSession
public interface RequestQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchRequests

      boolean canSearchRequests()
      Tests if this user can perform Request 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 requests 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.

    • getRequestQuery

      RequestQuery getRequestQuery()
      Gets a request query.
      Returns:
      the request query
      Compliance:
      mandatory - This method must be implemented.

    • getRequestsByQuery

      RequestList getRequestsByQuery(RequestQuery requestQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Requests matching the given request query.
      Parameters:
      requestQuery - the request query
      Returns:
      the returned RequestList
      Throws:
      NullArgumentException - requestQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - requestQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.