Interface CourseLookupSession

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

This session defines methods for retrieving courses. A Course is a canonical course listed in a course catalog. A CourseOffering is derived from a Course and maps to an offering time and registered students.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated course catalog view: All course methods in this session operate, retrieve and pertain to courses defined explicitly in the current course catalog. Using an isolated view is useful for managing Courses with the CourseAdminSession .
  • federated course catalog view: All course lookup methods in this session operate, retrieve and pertain to all courses defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence.
  • active course view: All course lookup methods return courses which are active.
  • any active course view: Courses of any active or inactive status are returned from methods.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

Courses may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Course .

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

    • canLookupCourses

      boolean canLookupCourses()
      Tests if this user can perform Course lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeCourseView

      void useComparativeCourseView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryCourseView

      void usePlenaryCourseView()
      A complete view of the Course returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedCourseCatalogView

      void useFederatedCourseCatalogView()
      Federates the view for methods in this session. A federated view will include courses in catalogs which are children of this catalog in the course catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCourseCatalogView

      void useIsolatedCourseCatalogView()
      Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveCourseView

      void useActiveCourseView()
      Only active courses are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusCourseView

      void useAnyStatusCourseView()
      All courses of any active or inactive status are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getCourse

      Course getCourse(Id courseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Course specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Course may have a different Id than requested, such as the case where a duplicate Id was assigned to a Course and retained for compatibility. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      courseId - the Id of the Course to retrieve
      Returns:
      the returned Course
      Throws:
      NotFoundException - no Course found with the given Id
      NullArgumentException - courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByIds

      CourseList getCoursesByIds(IdList courseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CourseList corresponding to the given IdList . In plenary mode, the returned list contains all of the courses specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Courses may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      courseIds - the list of Ids to retrieve
      Returns:
      the returned CourseList list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - courseIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByGenusType

      CourseList getCoursesByGenusType(Type courseGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList corresponding to the given course genus Type which does not include courses of types derived from the specified Type . In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      courseGenusType - a course genus type
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - courseGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByParentGenusType

      CourseList getCoursesByParentGenusType(Type courseGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList corresponding to the given course genus Type and include any additional courses with genus types derived from the specified Type . In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      courseGenusType - a course genus type
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - courseGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByRecordType

      CourseList getCoursesByRecordType(Type courseRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList containing the given course record Type . In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      courseRecordType - a course record type
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - courseRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByNumber

      CourseList getCoursesByNumber(String number) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList by the given number. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      number - a course number
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - number is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesBySponsor

      CourseList getCoursesBySponsor(Id sponsorId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList by the given sponsor. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      sponsorId - a sponsor Id
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - sponsorId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByObjective

      CourseList getCoursesByObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList by the given learning objective. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      objectiveId - a learning objective Id
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - objectiveId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCoursesByConcurrentCourse

      CourseList getCoursesByConcurrentCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseList by the given concurrent course. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Parameters:
      courseId - a course Id
      Returns:
      the returned CourseList list
      Throws:
      NullArgumentException - courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourses

      CourseList getCourses() throws OperationFailedException, PermissionDeniedException
      Gets all Courses . In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
      Returns:
      a list of Courses
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.