Interface CourseRegistrationSearchSession

All Superinterfaces:
AutoCloseable, Closeable, CourseRegistrationQuerySession, OsidSession, OsidSession
public interface CourseRegistrationSearchSession extends CourseRegistrationQuerySession

This session provides methods for searching among CourseRegistrations . The search query is constructed using the CourseRegistrationQuery .

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

This session defines views that offer differing behaviors for searching.

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

Course Registrations may have a query record indicated by their respective record types. The query record is access ed via the CourseRegistrationQuery .

  • Method Details

    • getCourseRegistrationSearch

      CourseRegistrationSearch getCourseRegistrationSearch()
      Gets a course registration search.
      Returns:
      the course registration search
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationSearchOrder

      CourseRegistrationSearchOrder getCourseRegistrationSearchOrder()
      Gets a course registration search order. The CourseRegistrationSearchOrder is supplied to a CourseRegistrationSearch to specify the ordering of results.
      Returns:
      the course registration search order
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationsBySearch

      CourseRegistrationSearchResults getCourseRegistrationsBySearch(CourseRegistrationQuery courseRegistrationQuery, CourseRegistrationSearch courseRegistrationSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      courseRegistrationQuery - the course registration query
      courseRegistrationSearch - the course registration search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - courseRegistrationQuery or courseRegistrationSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - courseRegistrationQuery or courseRegistrationSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationQueryFromInspector

      CourseRegistrationQuery getCourseRegistrationQueryFromInspector(CourseRegistrationQueryInspector courseRegistrationQueryInspector)
      Gets a course registration query from an inspector. The inspector is available from a CourseRegistrationSearchResults .
      Parameters:
      courseRegistrationQueryInspector - a course registration query inspector
      Returns:
      the course registration query
      Throws:
      NullArgumentException - courseRegistrationQueryInspector is null
      UnsupportedException - courseRegistrationQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.