Interface AssessmentEntrySmartCourseCatalogSession

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

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

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

    • getAssessmentEntryQuery

      AssessmentEntryQuery getAssessmentEntryQuery()
      Gets an assessment entry query.
      Returns:
      the assessment entry query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentEntrySearchOrder

      AssessmentEntrySearchOrder getAssessmentEntrySearchOrder()
      Gets an assessment entry search order.
      Returns:
      the assessment entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAssessmentEntryQuery

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

    • inspectAssessmentEntryQuery

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

    • applyAssessmentEntrySequencing

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

    • getAssessmentEntryQueryFromInspector

      AssessmentEntryQuery getAssessmentEntryQueryFromInspector(AssessmentEntryQueryInspector assessmentEntryQueryInspector)
      Gets an assessment entry query from an inspector.
      Parameters:
      assessmentEntryQueryInspector - a query inspector
      Returns:
      the assessment entry query
      Throws:
      NullArgumentException - assessmentEntryQueryInspector is null
      UnsupportedException - assessmentEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.