Interface CourseEntryLookupSession

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

This session defines methods for retrieving course entries.

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 entry methods in this session operate, retrieve and pertain to course entries defined explicitly in the current course catalog. Using an isolated view is useful for managing CourseEntries with the CourseEntry AdminSession .
  • federated course catalog view: All course entry lookup methods in this session operate, retrieve and pertain to all course entries defined in this course catalog and any other course entries implicitly available in this course catalog through course catalog inheritence.
  • effective course entry view: All course entry lookup methods return course entry where the current date falls in between the effective dates inclusive.
  • any course entry view: Course entries of any effective date are returned from methods.

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

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

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

    • canLookupCourseEntries

      boolean canLookupCourseEntries()
      Tests if this user can perform CourseEntry 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.

    • useComparativeCourseEntryView

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

    • usePlenaryCourseEntryView

      void usePlenaryCourseEntryView()
      A complete view of the CourseEntry 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 course entries 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.

    • useEffectiveCourseEntryView

      void useEffectiveCourseEntryView()
      Only course entries whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveCourseEntryView

      void useAnyEffectiveCourseEntryView()
      All course entries of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getCourseEntry

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

    • getCourseEntriesByIds

      CourseEntryList getCourseEntriesByIds(IdList courseEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList corresponding to the given IdList . In plenary mode, the returned list contains all of the course entries 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 CourseEntries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      courseEntryIds - the list of Ids to retrieve
      Returns:
      the returned CourseEntryList
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - courseEntryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntriesByGenusType

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

    • getCourseEntriesByParentGenusType

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

    • getCourseEntriesByRecordType

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

    • getCourseEntriesOnDate

      CourseEntryList getCourseEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList effective during the entire given date range inclusive but not confined to the date range. This method return sthe same results in either effective status mode. In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      from - starting date
      to - ending date
      Returns:
      the returned CourseEntryList list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntriesForStudent

      CourseEntryList getCourseEntriesForStudent(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList for the given student. In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned CourseEntryList list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntriesForStudentOnDate

      CourseEntryList getCourseEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList for the given student effective during the entire given date range inclusive but not confined to the date range. This method return sthe same results in either effective status mode. In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      from - starting date
      to - ending date
      Returns:
      the returned CourseEntryList list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntriesForCourse

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

    • getCourseEntriesForCourseOnDate

      CourseEntryList getCourseEntriesForCourseOnDate(Id courseId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList for the given course effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      courseId - a course Id
      from - starting date
      to - ending date
      Returns:
      the returned CourseEntryList list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - courseId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntriesForStudentAndCourse

      CourseEntryList getCourseEntriesForStudentAndCourse(Id resourceId, Id courseId) throws OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList for the given student and course. In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      courseId - a course Id
      Returns:
      the returned CourseEntryList list
      Throws:
      NullArgumentException - resourceId or courseId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntriesForStudentAndCourseOnDate

      CourseEntryList getCourseEntriesForStudentAndCourseOnDate(Id resourceId, Id courseId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CourseEntryList for the given student and course effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      courseId - a course Id
      from - starting date
      to - ending date
      Returns:
      the returned CourseEntryList list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId, courseId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCourseEntries

      CourseEntryList getCourseEntries() throws OperationFailedException, PermissionDeniedException
      Gets all CourseEntries . In plenary mode, the returned list contains all known course entries or an error results. Otherwise, the returned list may contain only those course entries that are accessible through this session. In effective mode, course entries are returned that are currently effective. In any effective mode, effective course entries and those currently expired are returned.
      Returns:
      a list of CourseEntries
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.