Interface PlanSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PlanQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Plans . The lessonsmay be sequenced using the PlanSearchOrder from this session.

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

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

    • getPlanQuery

      PlanQuery getPlanQuery()
      Gets a plan query.
      Returns:
      the plan query
      Compliance:
      mandatory - This method must be implemented.

    • getPlanSearchOrder

      PlanSearchOrder getPlanSearchOrder()
      Gets a plan search order.
      Returns:
      the plan search order
      Compliance:
      mandatory - This method must be implemented.

    • applyPlanQuery

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

    • inspectPlanQuery

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

    • applyPlanSequencing

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

    • getPlanQueryFromInspector

      PlanQuery getPlanQueryFromInspector(PlanQueryInspector planQueryInspector)
      Gets a plan query from an inspector.
      Parameters:
      planQueryInspector - a query inspector
      Returns:
      the plan query
      Throws:
      NullArgumentException - planQueryInspector is null
      UnsupportedException - planQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.