Interface RequestSearchSession

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

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

getRequestsByQuery() is the basic search method and returns a list of Requests. A more advanced search may be performed with getRequestsBySearch().It accepts a RequestSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRequestsBySearch() returns a RequestSearchResults that can be used to access the resulting RequestList or be used to perform a search within the result set through RequestSearch.

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.

Like all OsidSessions, RequestSearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getRequestSearch

      RequestSearch getRequestSearch()
      Gets a request search.
      Returns:
      the request search
      Compliance:
      mandatory - This method must be implemented.

    • getRequestSearchOrder

      RequestSearchOrder getRequestSearchOrder()
      Gets a request search order. The RequestSearchOrder is supplied to a RequestSearch to specify the ordering of results.
      Returns:
      the request search order
      Compliance:
      mandatory - This method must be implemented.

    • getRequestsBySearch

      RequestSearchResults getRequestsBySearch(RequestQuery requestQuery, RequestSearch requestSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      requestQuery - the request query
      requestSearch - the request search
      Returns:
      the request search results
      Throws:
      NullArgumentException - requestQuery or requestSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - requestQuery or requestSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRequestQueryFromInspector

      RequestQuery getRequestQueryFromInspector(RequestQueryInspector requestQueryInspector)
      Gets a request query from an inspector. The inspector is available from a RequestSearchResults.
      Parameters:
      requestQueryInspector - a request query inspector
      Returns:
      the request query
      Throws:
      NullArgumentException - requestQueryInspector is null
      UnsupportedException - requestQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.