Interface AwardEntrySmartCourseCatalogSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AwardEntryQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of AwardEntries . The courses may be sequenced using the AwardEntrySearchOrder 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 an AwardEntryQueryInspector . The query may be modified by converting the inspector back to an AwardEntryQuery .

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

    • getAwardEntryQuery

      AwardEntryQuery getAwardEntryQuery()
      Gets an award entry query.
      Returns:
      the award entry query
      Compliance:
      mandatory - This method must be implemented.

    • getAwardEntrySearchOrder

      AwardEntrySearchOrder getAwardEntrySearchOrder()
      Gets an award entry search order.
      Returns:
      the award entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAwardEntryQuery

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

    • inspectAwardEntryQuery

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

    • applyAwardEntrySequencing

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

    • getAwardEntryQueryFromInspector

      AwardEntryQuery getAwardEntryQueryFromInspector(AwardEntryQueryInspector awardEntryQueryInspector)
      Gets an award entry query from an inspector.
      Parameters:
      awardEntryQueryInspector - a query inspector
      Returns:
      the award entry query
      Throws:
      NullArgumentException - awardEntryQueryInspector is null
      UnsupportedException - awardEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.