Interface RegistrationTargetSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RegistrationTarget Query can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of RegistrationTar gets. The registration targets may be sequenced using the RegistrationTargetSearch Order from this session.

This CourseCatalog has a default query that matches any registration target and a default search order that specifies no sequencing. The queries may be examined using a RegistrationTargetQueryInspe ctor. The query may be modified by converting the inspector back to a RegistrationTargetQuery .

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

    • getRegistrationTargetQuery

      RegistrationTargetQuery getRegistrationTargetQuery()
      Gets a registration target query.
      Returns:
      the registration target query
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTargetSearchOrder

      RegistrationTargetSearchOrder getRegistrationTargetSearchOrder()
      Gets a registration target search order.
      Returns:
      the registration target search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRegistrationTargetQuery

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

    • inspectRegistrationTargetQuery

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

    • applyRegistrationTargetSequencing

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

    • getRegistrationTargetQueryFromInspector

      RegistrationTargetQuery getRegistrationTargetQueryFromInspector(RegistrationTargetQueryInspector registrationTargetQueryInspector)
      Gets a registration target query from an inspector.
      Parameters:
      registrationTargetQueryInspector - a registration target query inspector
      Returns:
      the registration target query
      Throws:
      NullArgumentException - registrationTargetQueryInspector is null
      UnsupportedException - registrationTargetQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.