Interface ActivityRegistrationSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActivityRegistrationQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of ActivityRegistrations . The activity registrations may be sequenced using the ActivityRegistrationSearchOrder from this session.

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

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

    • getActivityRegistrationQuery

      ActivityRegistrationQuery getActivityRegistrationQuery()
      Gets an activity registration query.
      Returns:
      the activity registration query
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRegistrationSearchOrder

      ActivityRegistrationSearchOrder getActivityRegistrationSearchOrder()
      Gets an activity registration search order.
      Returns:
      the activity registration search order
      Compliance:
      mandatory - This method must be implemented.

    • applyActivityRegistrationQuery

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

    • inspectActivityRegistrationQuery

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

    • applyActivityRegistrationSequencing

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

    • getActivityRegistrationQueryFromInspector

      ActivityRegistrationQuery getActivityRegistrationQueryFromInspector(ActivityRegistrationQueryInspector activityRegistrationQueryInspector)
      Gets an activity registration query from an inspector.
      Parameters:
      activityRegistrationQueryInspector - a query inspector
      Returns:
      the activity registration query
      Throws:
      NullArgumentException - activityRegistrationQueryInspector is null
      UnsupportedException - activityRegistrationQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.