Interface RegistrationRequestSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RegistrationReques tQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of RegistrationReq uests. The registration requests may be sequenced using the RegistrationRequestSearc hOrder from this session.

This CourseCatalog has a default query that matches any registration request and a default search order that specifies no sequencing. The queries may be examined using a RegistrationRequestQueryInsp ector. The query may be modified by converting the inspector back to a RegistrationRequestQuery .

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

    • getRegistrationRequestQuery

      RegistrationRequestQuery getRegistrationRequestQuery()
      Gets a registration request query.
      Returns:
      the registration request query
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestSearchOrder

      RegistrationRequestSearchOrder getRegistrationRequestSearchOrder()
      Gets a registration request search order.
      Returns:
      the registration request search order
      Compliance:
      mandatory - This method must be implemented.

    • applyRegistrationRequestQuery

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

    • inspectRegistrationRequestQuery

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

    • applyRegistrationRequestSequencing

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

    • getRegistrationRequestQueryFromInspector

      RegistrationRequestQuery getRegistrationRequestQueryFromInspector(RegistrationRequestQueryInspector registrationRequestQueryInspector)
      Gets a registration request query from an inspector.
      Parameters:
      registrationRequestQueryInspector - a registration request query inspector
      Returns:
      the registration request query
      Throws:
      NullArgumentException - registrationRequestQueryInspector is null
      UnsupportedException - registrationRequestQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.