Interface RegistrationRequestSearchSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RegistrationRequestQuerySession
public interface RegistrationRequestSearchSession extends RegistrationRequestQuerySession

This session provides methods for searching among RegistrationRequests . The search query is constructed using the RegistrationRequestQuery .

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

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include registration requests in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to registration requests in this course catalog

Registration Requests may have a query record indicated by their respective record types. The query record is acc essed via the RegistrationRequestQuery .

  • Method Details

    • getRegistrationRequestSearch

      RegistrationRequestSearch getRegistrationRequestSearch()
      Gets a registration request search.
      Returns:
      the registration request search
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestSearchOrder

      RegistrationRequestSearchOrder getRegistrationRequestSearchOrder()
      Gets a registration request search order. The RegistrationRequestSearchOrder is supplied to a RegistrationRequestSearch to specify the ordering of results.
      Returns:
      the registration request search order
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestsBySearch

      RegistrationRequestSearchResults getRegistrationRequestsBySearch(RegistrationRequestQuery registrationRequestQuery, RegistrationRequestSearch registrationRequestSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      registrationRequestQuery - the registration request query
      registrationRequestSearch - the registration request search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - registrationRequestQuery or registrationRequestSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - registrationRequestQuery or registrationRequestSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestQueryFromInspector

      RegistrationRequestQuery getRegistrationRequestQueryFromInspector(RegistrationRequestQueryInspector registrationRequestQueryInspector)
      Gets a registration request query from an inspector. The inspector is available from a RegistrationRequestSearchResults .
      Parameters:
      registrationRequestQueryInspector - a registration request query inspector
      Returns:
      the registration request query
      Throws:
      NullArgumentException - registrationRequestQueryInspector is null
      UnsupportedException - registrationRequestQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.