Interface CourseOfferingQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CourseOfferingSearchSession
public interface CourseOfferingQuerySession extends OsidSession

This session provides methods for searching among CourseOfferings. The search query is constructed using the CourseOfferingQuery.

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include course offerings 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 offerings in this course catalog

Course Offerings may have a query record indicated by their respective query record types. The query record is accessed via the CourseOfferingQuery.

  • Method Details

    • getCourseCatalogId

      Id getCourseCatalogId()
      Gets the CourseCatalog Id associated with this session.
      Returns:
      the CourseCatalog Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalog

      CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog associated with this session.
      Returns:
      the course catalog
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchCourseOfferings

      boolean canSearchCourseOfferings()
      Tests if this user can perform CourseOffering 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.

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include course offerings in course catalog which are children of this course catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • getCourseOfferingQuery

      CourseOfferingQuery getCourseOfferingQuery()
      Gets a course offering query.
      Returns:
      the course offering query.
      Compliance:
      mandatory - This method must be implemented.

    • getCourseOfferingsByQuery

      CourseOfferingList getCourseOfferingsByQuery(CourseOfferingQuery courseQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of CourseOfferings matching the given course offering query.
      Parameters:
      courseQuery - the course offering query
      Returns:
      the returned CourseOfferingList
      Throws:
      NullArgumentException - courseOfferingQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - courseOfferingQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.