Interface CourseRegistrationSmartCourseCatalogSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface CourseRegistrationSmartCourseCatalogSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CourseRegistration Query can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of CourseRegistrat ions. The course registrations may be sequenced using the CourseRegistrationSearch Order from this session.

This CourseCatalog has a default query that matches any course registration and a default search order that specifies no sequencing. The queries may be examined using a CourseRegistrationQueryInspe ctor. The query may be modified by converting the inspector back to a CourseRegistrationQuery .

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

    • canManageSmartCourseCatalogs

      boolean canManageSmartCourseCatalogs()
      Tests if this user can manage smart course catalogs. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart course catalog management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationQuery

      CourseRegistrationQuery getCourseRegistrationQuery()
      Gets a course registration query.
      Returns:
      the course registration query
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationSearchOrder

      CourseRegistrationSearchOrder getCourseRegistrationSearchOrder()
      Gets a course registration search order.
      Returns:
      the course registration search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCourseRegistrationQuery

      void applyCourseRegistrationQuery(CourseRegistrationQuery courseRegistrationQuery) throws OperationFailedException, PermissionDeniedException
      Applies a course registration query to this course catalog.
      Parameters:
      courseRegistrationQuery - the course registration query
      Throws:
      NullArgumentException - courseRegistrationQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - courseRegistrationQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCourseRegistrationQuery

      CourseRegistrationQueryInspector inspectCourseRegistrationQuery() throws OperationFailedException, PermissionDeniedException
      Gets a course registration query inspector for this course catalog.
      Returns:
      the course registration query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyCourseRegistrationSequencing

      void applyCourseRegistrationSequencing(CourseRegistrationSearchOrder courseRegistrationSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a course registration search order to this course catalog.
      Parameters:
      courseRegistrationSearchOrder - the course registration search order
      Throws:
      NullArgumentException - courseRegistrationSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - courseRegistrationSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationQueryFromInspector

      CourseRegistrationQuery getCourseRegistrationQueryFromInspector(CourseRegistrationQueryInspector courseRegistrationQueryInspector)
      Gets a course registration query from an inspector.
      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.