Interface CourseRegistrationCourseCatalogSession

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

This session provides methods to retrieve CourseRegistr ation to CourseCatalog mappings. A CourseRegistr ation may appear in multiple CourseCatalog obj ects. Each course catalog may have its own authorizations governing who is allowed to look at it.

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

  • Method Details

    • canLookupCourseRegistrationCourseCatalogMappings

      boolean canLookupCourseRegistrationCourseCatalogMappings()
      Tests if this user can perform lookups of course registration/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeCourseRegistrationCourseCatalogView

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

    • usePlenaryCourseRegistrationCourseCatalogView

      void usePlenaryCourseRegistrationCourseCatalogView()
      A complete view of the CourseRegistration and CourseCatalog 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.

    • getCourseRegistrationIdsByCourseCatalog

      IdList getCourseRegistrationIdsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of CourseRegistrationIds associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related course registration Ids
      Throws:
      NotFoundException - courseCatalogId is not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationsByCourseCatalog

      CourseRegistrationList getCourseRegistrationsByCourseCatalog(Id courseCatalogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of CourseRegistrations associated with a CourseCatalog .
      Parameters:
      courseCatalogId - Id of the CourseCatalog
      Returns:
      list of related course registrations
      Throws:
      NotFoundException - courseCatalogId is not found
      NullArgumentException - courseCatalogId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationIdsByCourseCatalogs

      IdList getCourseRegistrationIdsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of CourseRegistrationIds corresponding to a list of Course Catalogs .
      Parameters:
      courseCatalogIds - list of course catalog Ids
      Returns:
      list of course registration Ids
      Throws:
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseRegistrationsByCourseCatalogs

      CourseRegistrationList getCourseRegistrationsByCourseCatalogs(IdList courseCatalogIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of CourseRegistration corresponding to a list of Course Catalogs .
      Parameters:
      courseCatalogIds - list of course catalog Ids
      Returns:
      list of course registrations
      Throws:
      NullArgumentException - courseCatalogIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogIdsByCourseRegistration

      IdList getCourseCatalogIdsByCourseRegistration(Id courseRegistrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalog Ids mapped to a CourseRegistration .
      Parameters:
      courseRegistrationId - Id of a CourseRegistration
      Returns:
      list of course catalog Ids
      Throws:
      NotFoundException - courseRegistrationId is not found
      NullArgumentException - courseRegistrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogsByCourseRegistration

      CourseCatalogList getCourseCatalogsByCourseRegistration(Id courseRegistrationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CourseCatalogs mapped to a CourseRegistration .
      Parameters:
      courseRegistrationId - Id of a CourseRegistration
      Returns:
      list of course catalogs
      Throws:
      NotFoundException - courseRegistrationId is not found
      NullArgumentException - courseRegistrationId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.