Interface ActivityUnitSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActivityUnitQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of ActivityUnits . The activity units may be sequenced using the ActivityUnitSearchOrder from this session.

This CourseCatalog has a default query that matches any activity unit and a default search order that specifies no sequencing. The queries may be examined using an ActivityUnitQueryInspector . The query may be modified by converting the inspector back to an ActivityUnitQuery .

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

    • getActivityUnitQuery

      ActivityUnitQuery getActivityUnitQuery()
      Gets an activity unit query.
      Returns:
      the activity unit query
      Compliance:
      mandatory - This method must be implemented.

    • getActivityUnitSearchOrder

      ActivityUnitSearchOrder getActivityUnitSearchOrder()
      Gets an activity unit search order.
      Returns:
      the activity unit search order
      Compliance:
      mandatory - This method must be implemented.

    • applyActivityUnitQuery

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

    • inspectActivityUnitQuery

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

    • applyActivityUnitSequencing

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

    • getActivityUnitQueryFromInspector

      ActivityUnitQuery getActivityUnitQueryFromInspector(ActivityUnitQueryInspector activityUnitQueryInspector)
      Gets an activity unit query from an inspector.
      Parameters:
      activityUnitQueryInspector - a query inspector
      Returns:
      the activity unit query
      Throws:
      NullArgumentException - activityUnitQueryInspector is null
      UnsupportedException - activityUnitQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.