Interface CourseProgramLookupSession

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

This session defines methods for retrieving course program mappings. A Course maps to many Programs and a Program may be shared among multiple Courses .

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 lookup methods in this session operate, retrieve and pertain to courses and programs defined explicitly in the current course catalog.
  • federated course catalog view: All lookup methods in this session operate, retrieve and pertain to all courses and programs defined in this course catalog and any other courses and programs implicitly available in this course catalog through course catalog inheritence.

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

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

    • canLookupCourseProgramMappings

      boolean canLookupCourseProgramMappings()
      Tests if this user can perform Course/Program 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.

    • useComparativeCourseProgramView

      void useComparativeCourseProgramView()
      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.

    • usePlenaryCourseProgramView

      void usePlenaryCourseProgramView()
      A complete view of the lookups 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 and programs 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.

    • getCoursesForProgram

      CourseList getCoursesForProgram(IdList programId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CourseList corresponding to the given Program . In plenary mode, the returned list contains all of the courses, or an error results if a course is not found or inaccessible. Otherwise, inaccessible Courses may be omitted from the list.
      Parameters:
      programId - a program Id
      Returns:
      the returned Course list
      Throws:
      NotFoundException - programId not found
      NullArgumentException - programId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getProgramsForCourse

      ProgramList getProgramsForCourse(Id courseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Programs for the given Course . In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.
      Parameters:
      courseId - the Id of the Course to retrieve
      Returns:
      the returned Program list
      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.