Interface ModuleSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ModuleQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Modules . The docetsmay be sequenced using the ModuleSearchOrder from this session.

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

  • 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 CourseCatalog associated with this session
      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.

    • getModuleQuery

      ModuleQuery getModuleQuery()
      Gets a module query.
      Returns:
      the module query
      Compliance:
      mandatory - This method must be implemented.

    • getModuleSearchOrder

      ModuleSearchOrder getModuleSearchOrder()
      Gets a module search order.
      Returns:
      the module search order
      Compliance:
      mandatory - This method must be implemented.

    • applyModuleQuery

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

    • inspectModuleQuery

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

    • applyModuleSequencing

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

    • getModuleQueryFromInspector

      ModuleQuery getModuleQueryFromInspector(ModuleQueryInspector moduleQueryInspector)
      Gets a module query from an inspector.
      Parameters:
      moduleQueryInspector - a query inspector
      Returns:
      the module query
      Throws:
      NullArgumentException - moduleQueryInspector is null
      UnsupportedException - moduleQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.