Interface RegistrationRequestItemSmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RegistrationReques tItemQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of RegistrationReq uestItems. The registration request items may be sequenced using the RegistrationRequestItemS earchOrder from this session.

This CourseCatalog has a default query that matches any registration request item and a default search order that specifies no sequencing. The queries may be examined using a RegistrationRequestItemQuery Inspector. The query may be modified by converting the inspector back to a RegistrationRequestItemQ uery.

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

    • getRegistrationRequestItemQuery

      RegistrationRequestItemQuery getRegistrationRequestItemQuery()
      Gets a registration request item query.
      Returns:
      the registration request item query
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemSearchOrder

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

    • applyRegistrationRequestItemQuery

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

    • inspectRegistrationRequestItemQuery

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

    • applyRegistrationRequestItemSequencing

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

    • getRegistrationRequestItemQueryFromInspector

      RegistrationRequestItemQuery getRegistrationRequestItemQueryFromInspector(RegistrationRequestItemQueryInspector registrationRequestItemQueryInspector)
      Gets a registration request item query from an inspector.
      Parameters:
      registrationRequestItemQueryInspector - a registration request item query inspector
      Returns:
      the registration request item query
      Throws:
      NullArgumentException - registrationRequestItemQueryInspector is null
      UnsupportedException - registrationRequestItemQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.