Interface CourseEntrySmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CourseEntryQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of CourseEntries . The courses may be sequenced using the CourseEntrySearchOrder from this session.

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

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

    • getCourseEntryQuery

      CourseEntryQuery getCourseEntryQuery()
      Gets a course entry query.
      Returns:
      the course entry query
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntrySearchOrder

      CourseEntrySearchOrder getCourseEntrySearchOrder()
      Gets a course entry search order.
      Returns:
      the course entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCourseEntryQuery

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

    • inspectCourseEntryQuery

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

    • applyCourseEntrySequencing

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

    • getCourseEntryQueryFromInspector

      CourseEntryQuery getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)
      Gets a course entry query from an inspector.
      Parameters:
      courseEntryQueryInspector - a query inspector
      Returns:
      the course entry query
      Throws:
      NullArgumentException - courseEntryQueryInspector is null
      UnsupportedException - courseEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.