Interface ProgramEntrySmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProgramEntryQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of ProgramEntries . The courses may be sequenced using the ProgramEntrySearchOrder from this session.

This CourseCatalog has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a ProgramEntryQueryInspector . The query may be modified by converting the inspector back to a ProgramEntryQuery .

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

    • getProgramEntryQuery

      ProgramEntryQuery getProgramEntryQuery()
      Gets a program entry query.
      Returns:
      the program entry query
      Compliance:
      mandatory - This method must be implemented.

    • getProgramEntrySearchOrder

      ProgramEntrySearchOrder getProgramEntrySearchOrder()
      Gets a program entry search order.
      Returns:
      the program entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyProgramEntryQuery

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

    • inspectProgramEntryQuery

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

    • applyProgramEntrySequencing

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

    • getProgramEntryQueryFromInspector

      ProgramEntryQuery getProgramEntryQueryFromInspector(ProgramEntryQueryInspector programEntryQueryInspector)
      Gets a program entry query from an inspector.
      Parameters:
      programEntryQueryInspector - a query inspector
      Returns:
      the program entry query
      Throws:
      NullArgumentException - programEntryQueryInspector is null
      UnsupportedException - programEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.