Interface RequisiteSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RequisiteQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Requisites . The courses may be sequenced using the RequisiteSearchOrder 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 RequisiteQueryInspector . The query may be modified by converting the inspector back to a RequisiteQuery .

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

    • getRequisiteQuery

      RequisiteQuery getRequisiteQuery()
      Gets a requisite query.
      Returns:
      the requisite query
      Compliance:
      mandatory - This method must be implemented.

    • getRequisiteSearchOrder

      RequisiteSearchOrder getRequisiteSearchOrder()
      Gets a requisite search order.
      Returns:
      the requisite search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRequisiteQuery

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

    • inspectRequisiteQuery

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

    • applyRequisiteSequencing

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

    • getRequisiteQueryFromInspector

      RequisiteQuery getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)
      Gets a requisite query from an inspector.
      Parameters:
      requisiteQueryInspector - a query inspector
      Returns:
      the requisite query
      Throws:
      NullArgumentException - requisiteQueryInspector is null
      UnsupportedException - requisiteQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.